Git Hooks and Actions

[devlinjunker]

IDEA: scripts/ directory:

- actions/ 
|-- (script files for actions to run successfully)
- deploy/
|-- (script files to run during deployment -- connecting to/installing/running on server)
- hooks/
|-- (script files to run with git hooks)
- release/
|-- (script files for building/creating releases)

Hooks:

• [ ] enforce workflow during local development
  • run build/tests on commit
  • need to know project build process
• enforce branch names to match labels (related to Start using Label Manager Action #8 )
  • https://itnext.io/using-git-hooks-to-enforce-branch-naming-policy-ffd81fa01e5e
  • type (e.g feature/bug/doc) followed by /
• prevent commit to branch based on branch name
  • branches: master, release-*
• [ ] prevent tags being pushed from developer machine (pre-push hook to verify no new tags)
  • only tag during release (in GitHub action)
  • tags are only pushed when explicitly told to
• enforce commit messages? (Related to Semantic Versioning #4)
  • https://www.conventionalcommits.org/en/v1.0.0

Actions

• Label Manager action (see Start using Label Manager Action #8)
  • https://github.com/marketplace/actions/github-labeler
• Clean up action strategy/naming
  • simple names (reflect when action occurs)
  • include branch name? action (merge/pr/issue/label/create)
• Keep actions up to date?
  • https://github.com/marketplace/actions/github-labeler#keep-up-to-date-with-github-dependabot
• use PR Details to apply label
  • https://github.com/marketplace/actions/pr-branch-labeler
  • merge branch name feature* apply subtask label
    • for filtering out when searching
  • merging branch name to apply label to PR (related to Start using Label Manager Action #8)
    • e.g. doc/feat/feature/poc/example/perf/performance/qa/test/bug/build
  • Separate action for this last commit wip: *** add status:wip label
• Prevent poc or status: wip labeled commits or branches from being merged (Related Start using Label Manager Action #8)
• prevent PR if status is failing on merge branch: https://github.com/cirruslabs/gh-submit-queue
• Release Actions
  • Create Release Branch using semantic version in README -- see Semantic Versioning #4 (0.8-SNAPSHOT creates release-0.8)
  • Increment version in README in master (0.8-SNAPSHOT -> 0.9-SNAPSHOT)
  • Github Release?
  • Git Tag
• auto merge: https://github.com/palantir/bulldozer
  • https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#issue_comment
  • squash and merge (but why? see Consider Squash or Rebase only? #17 )
  • on:
    • comment starting withmerge:? Comment with merge!
    • all required checks passing (no wip last commit)
  • message:
    • always include PR number in merge commit message
    • PR title
      • Enforce PR title in verify-merge action
        • match branch prefix
        • conventional commit style: <prefix>(optional scope): <description>
        • include PR number
    • use standarized merge commit message unless comment contains message after merge?
• [ ] Greate Gihub Actions to build project on PR and commit to master
  • this depends on on knowing the framework/build tools for the project though

[devlinjunker]

• review
  • Githook improvements template.hapi.rest#9
  • Githooks and Actions template.webpack.fend#21
  • Explore Github Actions template.hapi.rest#5

[devlinjunker]

Add Design Documents for any scripts that we add, we can add sequence diagrams maybe? and explain where info is coming from? and responses to user

see #7

[devlinjunker]

Created https://github.com/devlinjunker/test.github.actions