Skip to content

Commit

Permalink
Update to tmpl template repository version 0.10.0 (#71)
Browse files Browse the repository at this point in the history
Updated to `tmpl` version `0.10.0` [1] which comes with...

1. optimized GitHub action workflows for Go and Node [2] - this change
   has also already been resolved in GH-68 [5
   the `ci-go` GitHub Action workflow.
2. the regular Node package dependency & GitHub action version
   updates [3]
3. the migration to the Markdown style guide version `0.4.0` [4]

[1]: https://github.com/svengreb/tmpl/releases/tag/v0.10.0
[2]: svengreb/tmpl#84
[3]: svengreb/tmpl#86
[4]: svengreb/tmpl#76
[5]: #68

Closes GH-70
  • Loading branch information
svengreb committed Nov 20, 2021
1 parent c3ff68b commit 670859e
Show file tree
Hide file tree
Showing 5 changed files with 2,985 additions and 1,101 deletions.
1 change: 0 additions & 1 deletion .husky/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,10 @@ A style guide establishes and enforces style to improve the intelligibility and

tmpl-go adheres to the [Arctic Ice Studio JavaScript Style Guide][gh-styleguide-javascript].

[![][gh-styleguide-javascript-badge]][gh-styleguide-javascript]

### Markdown Style Guide

tmpl-go adheres to the [Arctic Ice Studio Markdown Style Guide][gh-styleguide-markdown].

[![][gh-styleguide-markdown-badge]][gh-styleguide-markdown]

### Git Commit Messages

A well-crafted Git commit message is the best way to communicate _context_ about a change to the maintainers. The code will tell what changed, but only the commit message can properly tell why. Re-establishing the context of a piece of code is wasteful. We can't avoid it completely, so our efforts should go to reducing it as much as possible.
Expand Down Expand Up @@ -203,9 +199,7 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os
[gh-profile-repo-search]: https://github.com/svengreb?&tab=repositories&q=tmpl
[gh-releases-latest]: https://github.com/svengreb/tmpl-go/releases/latest
[gh-styleguide-git]: https://github.com/arcticicestudio/styleguide-git
[gh-styleguide-javascript-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography-badge.svg?sanitize=true
[gh-styleguide-javascript]: https://github.com/arcticicestudio/styleguide-javascript
[gh-styleguide-markdown-badge]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true
[gh-styleguide-markdown]: https://github.com/arcticicestudio/styleguide-markdown
[gh-tmpl]: https://github.com/svengreb/tmpl
[ghd-attach-file]: https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ This template repository has partially been designed for repositories hosted on
#### CI/CD Action Workflows

The [GitHub Actions][gh-feat-actions] `.github/workflows` directory includes a basic [CI/CD workflow files][gh-docs-act-ref-syntax] that run for changes in the Git `main` branch and `v*` tags. The `lint-node` job is [derived from the _tmpl_ template repository][gh-tmpl#gh_act_cicd] and runs all [Node.js based linters][gh-tmpl#overview] that are also included in this template repository. The `ci-go` workflow runs all [configured `golangci-lint` linters](#go-code-quality-linting) and the `test` job runs all [tests with coverage report][go-doc-cmd-cover] and enabled [race detector][go-doc-race_detector].
To skip a workflow, include a [supported keyword like `[skip actions]`][gh-blog-cl-skip_actions] in a commit message.

#### Automated Dependency Updates

Expand Down Expand Up @@ -163,6 +164,7 @@ The guide also includes information about [minimal, complete, and verifiable exa
[gh-blob-tmpl-go_test.go]: https://github.com/svengreb/tmpl-go/blob/main/tmpl-go_test.go
[gh-blob-tmpl-go.go]: https://github.com/svengreb/tmpl-go/blob/main/tmpl-go.go
[gh-blob-web-readme]: https://github.com/svengreb/tmpl-go/blob/main/web/README.md
[gh-blog-cl-skip_actions]: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci
[gh-docs-act-ref-syntax]: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
[gh-docs-dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
[gh-docs-repo_clone]: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository
Expand Down

0 comments on commit 670859e

Please sign in to comment.