Skip to content

Commit

Permalink
docs(style):Update Development Pipeline style #35
Browse files Browse the repository at this point in the history
- Added tags to update-changelog.yaml TYPES
- Changed tag order to alphabetical
- Updated .git-commit-message to reflect styling and requirements for
  update-changelog.yaml

WIP #35
  • Loading branch information
imAsparky committed Jul 12, 2021
1 parent dce6027 commit 608574f
Showing 1 changed file with 48 additions and 44 deletions.
92 changes: 48 additions & 44 deletions docs/source/style-developer.rst
Expand Up @@ -24,58 +24,62 @@ The git commit message follows the
:linenos:
# tag(subject):<Description> #nn being the issue number if it exists
# |<---- Preferably using up to 50 chars --->|<--Max of 72 chars-->|
# Example: docs(style):Added a new reST style guide #42
# (Optional) Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# Example: There wasnt a reST style guide
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: closes #42
# --- COMMIT END ---
# Tag can be
# feat (new feature)
# fix (bug fix)
# refactor (refactoring code)
# style (formatting, missing semi colons, etc; no code change)
# doc (changes to documentation)
# test (adding or refactoring tests; no production code change)
# version (version bump/new release; no production code change)
# jsrXXX (Patches related to the implementation of jsrXXX, where XXX the JSR number)
# jdkX (Patches related to supporting jdkX as the host VM, where X the JDK version)
# dbg (Changes in debugging code/frameworks; no production code change)
# license (Edits regarding licensing; no production code change)
# hack (Temporary fix to make things move forward; please avoid it)
# WIP (Work In Progress; for intermediate commits to keep patches reasonably sized)
# defaults (changes default options)
#
# Note: Multiple tags can be combined, e.g. [fix][jsr292] Fix issue X with methodhandles
# --------------------
# Remember to:
# * Capitalize the subject line
# * Use the imperative mood in the subject line
# * Do not end the subject line with a period
# * Separate subject from body with a blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# --------------------
# tag(subject):<Description> #nn being the issue number if it exists
# (subject): CHANGELOG update groups items with the same subject.
# |<---- Preferably using up to 50 chars --->|<--Max of 72 chars-->|
# Example: docs(style):Added a new reST style guide #42
# (Optional) Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# Example: There wasnt a reST style guide.
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: closes #42
# --- COMMIT END ---
# Tags with ** will be included in the CHANGELOG
# ** chore (a chore that needs to be done)
# dbg (changes in debugging code/frameworks; no production code change)
# defaults (changes default options)
# ** doc (changes to documentation)
# ** feat (new feature)
# ** fix (bug fix)
# hack (temporary fix to make things move forward; please avoid it)
# license (edits regarding licensing; no production code change)
# ** perf (performance improvement)
# ** refactor (refactoring code)
# ** style (formatting, missing semi colons, etc; no code change)
# ** test (adding or refactoring tests; no production code change)
# version (version bump/new release; no production code change)
# WIP (Work In Progress; for intermediate commits to keep patches reasonably sized)
# jsrXXX (patches related to the implementation of jsrXXX, where XXX the JSR number)
# jdkX (patches related to supporting jdkX as the host VM, where X the JDK version)
#
# --------------------
# Remember to:
# * Capitalize the subject line start
# * Use the imperative mood in the subject line
# * Do not end the subject line with a period
# * Separate subject from body with a blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# --------------------
|
.. important::
For Auto-generate CHANGELOG Github Action to pick up the changes, the heading must be in the format.
For Auto-generate CHANGELOG Github Action to pick up the changes, the heading must be in the following format.

tag(subject):<Description> #nn being the issue number if it exists

Example: docs(style):Added a new reST style guide #42

(subject): CHANGELOG update groups items with the same subject.

|

Expand All @@ -96,7 +100,7 @@ Auto-generate CHANGELOG uses
on:
release:
types: [created, edited]
schedule:
schedule:
- cron: "0 2 * * *"
workflow_dispatch:
Expand All @@ -113,7 +117,7 @@ Auto-generate CHANGELOG uses
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
PATH: "/CHANGELOG.md"
COMMIT_MESSAGE: "docs(CHANGELOG): update release notes"
TYPE: "feat:Feature,fix:Bug Fixes,docs:Documentation,refactor:Refactor,perf:Performance Improvements,test:Tests, chore:Chore"
TYPE: "chore:Chore,feat:Feature,fix:Bug Fixes,docs:Documentation,perf:Performance Improvements,refactor:Refactor,style:Styling,test:Tests"
|
Expand Down

0 comments on commit 608574f

Please sign in to comment.