https://github.com/tmknom/general-template
A template repository for any languages that keep clean code.
https://github.com/tmknom/general-template
dependabot github github-actions template
Last synced: about 1 year ago
JSON representation
A template repository for any languages that keep clean code.
- Host: GitHub
- URL: https://github.com/tmknom/general-template
- Owner: tmknom
- License: apache-2.0
- Created: 2022-03-26T21:32:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T04:52:36.000Z (almost 3 years ago)
- Last Synced: 2023-09-06T05:42:33.701Z (almost 3 years ago)
- Topics: dependabot, github, github-actions, template
- Language: Makefile
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# General Template
A template repository for any languages that keep clean code.
## Description
N/A
## Usage
N/A
## Developer Guide
Click to see details
### Requirements
- [GNU Make](https://www.gnu.org/software/make/)
- [Docker](https://docs.docker.com/get-docker/)
- [GitHub CLI](https://cli.github.com/)
### Development
N/A
### Test
Run the following command:
```shell
make test
```
### CI
When create a pull request, the following workflows are executed automatically at GitHub Actions.
- [Lint Markdown](/.github/workflows/lint-markdown.yml)
- [Lint YAML](/.github/workflows/lint-yaml.yml)
- [Lint Action](/.github/workflows/lint-action.yml)
- [Lint Shell](/.github/workflows/lint-shell.yml)
### Dependency management
Use Dependabot version updates.
For more information, see [dependabot.yml](/.github/dependabot.yml).
### Release management
#### 1. Bump up to a new version
Run the following command to bump up.
```shell
make bump
```
This command will execute the following steps:
1. Update [VERSION](/VERSION)
2. Commit, push, and create a pull request
3. Open the web browser automatically for reviewing pull request
Then review and merge, so the release is ready to go.
#### 2. Publish the new version
Run the following command to publish a new tag at GitHub.
```shell
make release
```
Finally, we can use the new version! :tada:
## Changelog
See [CHANGELOG.md](/CHANGELOG.md).
## License
Apache 2 Licensed. See [LICENSE](/LICENSE) for full details.