-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/EIYARO/ey
- Loading branch information
Showing
4 changed files
with
173 additions
and
20 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| name: EIYARO Main Workflow | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| on: | ||
|
|
||
| push: | ||
| branches: [ main ] | ||
| tags: [ "*" ] | ||
| paths-ignore: [ "README.md", "CHANGELOG.md", "cliff.toml" ] | ||
|
|
||
| pull_request: | ||
| branches: [ main ] | ||
|
|
||
| jobs: | ||
|
|
||
| build: | ||
| name: Build Applications | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkput | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| submodules: true | ||
|
|
||
| - name: Set up Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: '1.22' | ||
|
|
||
| - name: Build Server | ||
| run: make eiyarod | ||
|
|
||
| - name: Build Client | ||
| run: make eiyarocli | ||
|
|
||
| release: | ||
| if: contains(github.ref_type, 'tag') | ||
| name: Create GitHub Release | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| submodules: true | ||
|
|
||
| - name: Build Release | ||
| run: make release-all | ||
|
|
||
| - name: Create GitHub release | ||
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| name: EIYARO ${{ env.tag }} | ||
| body: "## New release" | ||
| files: target/* | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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,85 @@ | ||
| # How to contribute | ||
|
|
||
|
|
||
| ## Formatting | ||
|
|
||
| All source code should be formatted using the default formatting rules for Go code, which your IDE should provide. | ||
|
|
||
| ## Commit Messages | ||
|
|
||
| (Originally from the [Udacity Git Commit Message Style Guide](https://udacity.github.io/git-styleguide/index.html)) | ||
|
|
||
| ### Message Structure | ||
|
|
||
| A commit messages consists of three distinct parts separated by a blank line: the title, an optional body and an optional footer. | ||
|
|
||
| The layout looks like this: | ||
| ``` | ||
| type: subject | ||
| body | ||
| footer | ||
| ``` | ||
|
|
||
| The title consists of the type of the message and subject. | ||
|
|
||
| ### The Type | ||
|
|
||
| The type is contained within the title and can be one of these types: | ||
|
|
||
| * feat: a new feature | ||
| * fix: a bug fix | ||
| * docs: changes to documentation | ||
| * style: formatting, missing semi colons, etc; no code change | ||
| * refactor: refactoring production code | ||
| * test: adding tests, refactoring test; no production code change | ||
| * chore: updating build tasks, package manager configs, etc; no production code change | ||
|
|
||
| ### The Subject | ||
|
|
||
| Subjects should be no greater than 50 characters, should begin with a capital letter and do not end with a period. | ||
|
|
||
| Use an imperative tone to describe what a commit does, rather than what it did. For example, use change; not changed or changes. | ||
|
|
||
| ### The Body | ||
|
|
||
| Not all commits are complex enough to warrant a body, therefore it is optional and only used when a commit requires a bit of explanation and context. Use the body to explain the what and why of a commit, not the how. | ||
|
|
||
| When writing a body, the blank line between the title and the body is required and you should limit the length of each line to no more than 72 characters. | ||
|
|
||
| ### The Footer | ||
|
|
||
| The footer is optional and is used to reference issue tracker IDs. | ||
|
|
||
| ### Example Commit Message | ||
|
|
||
| ``` | ||
| feat: Summarise changes in around 50 characters or less | ||
| More detailed explanatory text, if necessary. Wrap it to about 72 | ||
| characters or so. In some contexts, the first line is treated as the | ||
| subject of the commit and the rest of the text as the body. The | ||
| blank line separating the summary from the body is critical (unless | ||
| you omit the body entirely); various tools like `log`, `shortlog` | ||
| and `rebase` can get confused if you run the two together. | ||
| Explain the problem that this commit is solving. Focus on why you | ||
| are making this change as opposed to how (the code explains that). | ||
| Are there side effects or other non intuitive consequences of this | ||
| change? Here's the place to explain them. | ||
| Further paragraphs come after blank lines. | ||
| - Bullet points are okay, too | ||
| - Typically a hyphen or asterisk is used for the bullet, preceded | ||
| by a single space, with blank lines in between, but conventions | ||
| vary here | ||
| If you use an issue tracker, put references to them at the bottom, | ||
| like this: | ||
| Resolves: #123 | ||
| See also: #456, #789 | ||
| ``` |
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