generated from fallion/go-template
-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move all documentation into Docusaurus
- Loading branch information
Showing
17 changed files
with
129 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
id: flags | ||
title: Flags | ||
--- | ||
|
||
For more advanced usage a set of flags are provided. | ||
|
||
| Name | Flag | Required | Default | Description | | ||
| ------- | ----- | -------- | ------- | ---------------------------------------------------------------------------------- | | ||
| Verbose | --v | false | false | Debug output into console | | ||
| Strict | --s | false | true | Strict check of category types | | ||
| All | --all | false | false | Whether to check all commits on given branch. **Takes precedence over LIMIT flag** | | ||
|
||
On top of that a single argument is allowed: | ||
|
||
`commitsar <from commit>...<to commit>` | ||
|
||
e.g. `commitsar 7dbf3e7db93ae2e02902cae9d2f1de1b1e5c8c92...d0240d3ed34685d0a5329b185e120d3e8c205be4` | ||
|
||
If only one commit hash is used then commitsar will assume it to be the TO commit. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
id: binary | ||
title: Binary | ||
--- | ||
|
||
Adjust for version and distribution. Please check [Releases](https://github.com/aevea/commitsar/releases). | ||
|
||
``` | ||
- curl -L -O https://github.com/aevea/commitsar/releases/download/v0.0.2/commitsar_v0.0.2_Linux_x86_64.tar.gz | ||
- tar -xzf commitsar_v0.0.2_Linux_x86_64.tar.gz | ||
- ./commitsar | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
id: circleci | ||
title: CircleCI | ||
--- | ||
|
||
```yaml | ||
validate-commits: | ||
docker: | ||
- image: aevea/commitsar | ||
steps: | ||
- checkout | ||
- run: commitsar | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
id: docker | ||
title: Docker | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
id: github | ||
title: Github Actions | ||
--- | ||
|
||
Checkout git in order to get commits and master branch | ||
|
||
``` | ||
- name: Check out code into the Go module directory | ||
uses: actions/checkout@v1 | ||
``` | ||
|
||
Run the Commitsar action | ||
|
||
``` | ||
- name: Commitsar Action | ||
uses: aevea/commitsar@v0.6.3 (substitute for current version) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: gitlab | ||
title: Gitlab CI | ||
--- | ||
|
||
```yaml | ||
validate-commits: | ||
image: aevea/commitsar | ||
script: | ||
- commitsar | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
id: gobinaries | ||
title: GoBinaries | ||
--- | ||
|
||
Running using https://gobinaries.com/ | ||
|
||
```sh | ||
curl -sf https://gobinaries.com/aevea/commitsar | sh | ||
``` | ||
|
||
Or a specific version: | ||
```sh | ||
curl -sf https://gobinaries.com/aevea/commitsar[@VERSION] | sh | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
id: source | ||
title: Building from source | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,17 @@ | ||
module.exports = { | ||
someSidebar: { | ||
Introduction: ["intro"], | ||
"Usage": [ | ||
"usage/gobinaries", | ||
"usage/docker", | ||
"usage/github", | ||
"usage/gitlab", | ||
"usage/circleci", | ||
"usage/binary", | ||
"usage/source", | ||
], | ||
Configuration: [ | ||
"configuration/flags", | ||
], | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
a9e097d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to following URLs: