Skip to content

Commit

Permalink
initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-e-allen committed Apr 6, 2023
0 parents commit 8ed0aab
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/release.marvinpinto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "release"

on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+' # Match only a full sematic version tag, i.e. v20.15.10

jobs:
release:
name: "Create release"
runs-on: "ubuntu-latest"

steps:
# Full documentation: https://github.com/marvinpinto/action-automatic-releases
- uses: "marvinpinto/action-automatic-releases@latest"
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# demo-auto-release

Demo of GH Actions for automatic releases.

Free free make a commit and add a release tag!

## Git Commands to Create Release

This will create a Release with "v1.0.0" as the content/description of the release. The "v1.0.0" comes from the message in the annotated tag.

```
$ git add .
$ git commit -m "blah, blah"
$ git tag -a v1.0.0 -m "v1.0.0"
$ git push origin --follow-tags
# OR, if you have set the global push.followTags settings to true
$ git push origin
```


## Alternative That Shows Commits in the Release
```
$ git add .
$ git commit -m "blah, blah"
$ git push origin
$ git tag v1.0.0
$ git push origin v1.0.0
```

## Git Configuration
If you set `push.followTags` as shown below, you don't have to use the `--follow-tags` option in the command sequence above.

```
git config --global push.followTags true
```

## How The Release Github Action Works

This repo is configured with a Github Action workflow in [.github/workflows/release.marvinpinto.yml](.github/workflows/release.marvinpinto.yml) that implements the automatic release based on tags.

It relies on the [automatic-releases](https://github.com/marketplace/actions/automatic-releases) Github Action. That Action is one of many available to create Releases. Others may be better, but the one from Marvin Pinto is simple and does what's needed.

## Change Log

### v1.0.0
- initial commit

0 comments on commit 8ed0aab

Please # to comment.