Common GitHub Actions and scripts for Marp team projects.
jobs:
something:
steps:
- uses: marp-team/actions@v1
with:
task: release
token: ${{ secrets.GITHUB_TOKEN }}
Please note that provided actions are only for Marp team projects.
Pass the name of task to task
parameter in with
key of the step.
Update GitHub Release for the tagged version based on parsed contents from CHANGELOG.md
.
on:
push:
tags:
- v*
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: marp-team/actions@v1
with:
task: release
token: ${{ secrets.GITHUB_TOKEN }}
task
(required): Must berelease
.token
(required): GitHub token.convertGitHubMention
(optional:true
by default): Set whether to convert Markdown links to GitHub profile like[@marp-team](https://github.com/marp-team/)
into a plain GitHub mention.
Details about convertGitHubMention
To give credit, CHANGELOG.md
may mention to outside contributors who made a good improvement (e.g. Bug fix, critical update of docs, and so on. Minor fix such as typo may not mention the contributor).
We are using a traditional Markdown link into GitHub profile page to keep accessible when reading CHANGELOG.md
directly, but using @mention
syntax for GitHub releases is better because of the avatar list for to highlight and celebrate our collaborators.
Upload files to existing GitHub release for specified version.
on:
push:
tags:
- v*
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: marp-team/actions@v1
with:
task: upload
token: ${{ secrets.GITHUB_TOKEN }}
files: dist,pkg/xxxxxxxx.zip
task
(required): Must beupload
.token
(required): GitHub token.files
(required): Comma-separated string for upload files or directories.
This repository also provides a helper script of npm version
for including update of CHANGELOG.md
to bumped commit.
// package.json
{
"scripts": {
"version": "curl https://raw.githubusercontent.com/marp-team/actions/v1/lib/scripts/version.js | node && git add -A CHANGELOG.md"
}
}
We are following the contributing guideline of marp-team projects. Please read these guidelines this before starting work in this repository.
$ npm version [major|minor|patch]
$ git push && git push --tag
vX.X.X-release
tag for production use will create automatically when pushed a semantic versioning tag such as vX.X.X
. It includes compiled JS scripts and dependent modules for production.
In addition, the primary version tag such as v1
will move to the created commit by updated release tag when the pushed tag has no identifiers for prerelease.
Managed by @marp-team.