Skip to content

Commit

Permalink
feat!: adding support for ReleasePlease github action
Browse files Browse the repository at this point in the history
  • Loading branch information
ScottKirvan committed Dec 13, 2024
1 parent 44c7267 commit cc3fe28
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 18 deletions.
3 changes: 3 additions & 0 deletions .github/release-please/.release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "1.0.0"
}
13 changes: 13 additions & 0 deletions .github/release-please/release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"release-type": "simple",
"include-component-in-tag": false,
"changelog-path": "notes/CHANGELOG.md",
"packages": {
".": {
"extra-files": [
"notes/VERSION.md"
]
}
}
}
31 changes: 31 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Release Workflow

on:
push:
branches:
- main

permissions:
contents: write
pull-requests: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: googleapis/release-please-action@v4
id: release
with:
# this assumes that you have created a personal access token
# (PAT) and configured it as a GitHub action secret named
# `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
# token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ github.token }}
config-file: .github/release-please/release-please-config.json
manifest-file: .github/release-please/.release-please-manifest.json
# this is a built-in strategy in release-please, see "Action Inputs"
# for more options
# release-type: simple



1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<h1><a href="https://github.com/ScottKirvan/ScooterGitTemplate">ScottKirvan/ScooterGitTemplate</a></h1>
<h3>Nulla nobis dicta iste minus dolor repellendus aspernatur atque</h3>


<!-- Badges -->
<p>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/graphs/contributors">
Expand Down
24 changes: 8 additions & 16 deletions notes/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
# Changelog
All notable change to this project will be documented in this file.
>[!NOTE]
> This file and it's version format is automatically
> generated by [Please-Release](https://github.com/googleapis/release-please-action),
> and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.2.14](https://github.com/ScottKirvan/ReleasePleaseTest/compare/v1.2.13...v1.2.14) (2024-12-13)

## [Unreleased]

## [0.0.1] - 2023-01-06
### Added
- initial repo/template check-in
### Bug Fixes

-----------------------------------------------------------------------------
## Changelog Template:
- ***Added*** - for new features.
- ***Changed*** - for changes in existing functionality.
- ***Depricated*** - for soon-to-be removed features.
- ***Removed*** - for now removed features.
- ***Fixed*** - for any bug fixes.
- ***Refactored*** - no functional changes, just cleanup or reorganizing.
- ***Security*** - in case of vulnerabilities.
* change where my version info gets written ([75d58cb](https://github.com/ScottKirvan/ReleasePleaseTest/commit/75d58cb57ec461a179962bd2d29c115675b881a6))
* triggering a release ([dbe3ba9](https://github.com/ScottKirvan/ReleasePleaseTest/commit/dbe3ba949ddcd18d1584099d9f56963b1da10404))
3 changes: 3 additions & 0 deletions notes/VERSION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!-- x-release-please-start-version -->
version=1.2.14
<!-- x-release-please-end -->
20 changes: 18 additions & 2 deletions notes/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,22 @@ _This is italic text_
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
## Callouts / Alerts

> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
## Lists

Expand Down Expand Up @@ -193,7 +209,7 @@ see [how to change output](https://github.com/markdown-it/markdown-it-emoji#chan

Footnote 1 link[^first].

Footnote 2 link[^second].
Footnote 2 link[^2].

Inline footnote^[Text of inline footnote] definition.

Expand All @@ -203,7 +219,7 @@ Duplicated footnote reference[^second].

and multiple paragraphs.

[^second]: Footnote text.
[^2]: Footnote text.


### [Definition lists](https://github.com/markdown-it/markdown-it-deflist)
Expand Down

0 comments on commit cc3fe28

Please sign in to comment.