Skip to content

Commit

Permalink
docs: describe v1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilsk committed Nov 30, 2022
1 parent ce4b2f9 commit d112046
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 25 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ $ make go-1.11 # or go-1.12, etc.

## πŸ’‘ Idea

Define a powerful template that quickly creates a new Go module from scratch.
Define a powerful template that quickly creates a new Go module.
Not only does it provide a starting point for new projects,
but it comes equipped with pre-configured ci/cd and inventory.

Expand All @@ -74,13 +74,13 @@ rather than wasting time on environment configuration and copying boilerplate co
1. [Generate][action.generate] a new repository from the template.
2. Clone the repository locally.
3. Update files:
- `docs/CNAME`, `tools/pages/*`, `tools/*.jsx?`,
- `go.mod`, and `README.md`:
- πŸ›« Quick start
- πŸ’‘ Idea
- πŸ† Motivation
- πŸ€Όβ€ How to
- πŸ›¬ Integration
- `docs/CNAME`, `tools/pages/*`, `tools/*.jsx?`,
- `go.mod`, and `README.md`:
- [ ] πŸ›« Quick start
- [ ] πŸ’‘ Idea
- [ ] πŸ† Motivation
- [ ] πŸ€Όβ€ How to
- [ ] πŸ›¬ Integration
4. Write your code and tests.
5. πŸš€

Expand Down Expand Up @@ -110,10 +110,10 @@ or if you find an issue, [report it][action.issue] first.
2. [Makefiles](https://github.com/octomation/makefiles).
3. [Taskfiles](https://github.com/octomation/taskfiles).
4. Go tools:
- [mockgen](https://github.com/golang/mock),
- [golangci-lint](https://github.com/kamilsk/golangci-lint),
- [goimports](https://github.com/kamilsk/go-tools),
- [govulncheck](https://github.com/golang/vuln).
- [mockgen](https://github.com/golang/mock),
- [golangci-lint](https://github.com/kamilsk/golangci-lint),
- [goimports](https://github.com/kamilsk/go-tools),
- [govulncheck](https://github.com/golang/vuln).

### Optional

Expand Down
28 changes: 27 additions & 1 deletion tools/pages/changelog/v1.0.0.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Release notes, v1.0.0

Stay tuned.
πŸ‘‹ Hi, folks!

We are glad to announce the first stable release of the template
to help the Go community build their excellent modules faster! πŸŽ‰

## [Ready to go](https://github.com/octomation/go-module/milestone/1)

- Adopted for [Go 1.11..1.20](https://github.com/octomation/go-module/blob/ce4b2f9da00629de266f672db011616b97a8804c/.github/workflows/ci.yml#L59-L71) support.
- Call `make go-1.11 # go-1.12, etc.` and work with a module inside the specified Go environment.
- Has a lot of well-tested [workflows](https://github.com/octomation/go-module/tree/main/.github/workflows).
- Uses the full power of GitHub:
1. [GitHub Actions](https://github.com/features/actions).
2. [GitHub Pages](https://pages.github.com).
3. [Dependabot](https://github.com/dependabot).
- Implements best practices of Go.
- Includes [Makefiles](https://github.com/octomation/makefiles), [Taskfiles](https://github.com/octomation/taskfiles), and [tools](https://github.com/octomation/go-module/blob/main/tools/tools.go).

## [Out of the box](https://github.com/octomation/go-module/tree/main/.github/integrations)

### Slack integration

![image](https://user-images.githubusercontent.com/1165416/234065649-f9ac53ea-e420-4759-92ff-de2e071f5f0e.png)

### Documentation

Based on [Nextra](https://nextra.site), hosted by [GitHub Pages](https://pages.github.com).
See [the example](https://go-module.octolab.org).
24 changes: 12 additions & 12 deletions tools/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ $ make go-1.11 # or go-1.12, etc.

## πŸ’‘ Idea

Define a powerful template that quickly creates a new Go module from scratch.
Define a powerful template that quickly creates a new Go module.
Not only does it provide a starting point for new projects,
but it comes equipped with pre-configured ci/cd and inventory.

Expand All @@ -74,13 +74,13 @@ rather than wasting time on environment configuration and copying boilerplate co
1. [Generate][action.generate] a new repository from the template.
2. Clone the repository locally.
3. Update files:
- `docs/CNAME`, `tools/pages/*`, `tools/*.jsx?`,
- `go.mod`, and `README.md`:
- πŸ›« Quick start
- πŸ’‘ Idea
- πŸ† Motivation
- πŸ€Όβ€ How to
- πŸ›¬ Integration
- `docs/CNAME`, `tools/pages/*`, `tools/*.jsx?`,
- `go.mod`, and `README.md`:
- [ ] πŸ›« Quick start
- [ ] πŸ’‘ Idea
- [ ] πŸ† Motivation
- [ ] πŸ€Όβ€ How to
- [ ] πŸ›¬ Integration
4. Write your code and tests.
5. πŸš€

Expand Down Expand Up @@ -110,10 +110,10 @@ or if you find an issue, [report it][action.issue] first.
2. [Makefiles](https://github.com/octomation/makefiles).
3. [Taskfiles](https://github.com/octomation/taskfiles).
4. Go tools:
- [mockgen](https://github.com/golang/mock),
- [golangci-lint](https://github.com/kamilsk/golangci-lint),
- [goimports](https://github.com/kamilsk/go-tools),
- [govulncheck](https://github.com/golang/vuln).
- [mockgen](https://github.com/golang/mock),
- [golangci-lint](https://github.com/kamilsk/golangci-lint),
- [goimports](https://github.com/kamilsk/go-tools),
- [govulncheck](https://github.com/golang/vuln).

### Optional

Expand Down

0 comments on commit d112046

Please sign in to comment.