Skip to content

Commit

Permalink
Update TagBot.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
hhaensel authored Nov 20, 2023
1 parent 3cc76d5 commit 9f722e6
Showing 1 changed file with 15 additions and 69 deletions.
84 changes: 15 additions & 69 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -1,69 +1,15 @@
- name: Julia TagBot
# You may pin to the exact commit or the version.
# uses: JuliaRegistries/TagBot@4e2dfa4ac8ad1e1a0af1e03f8411855200fac8ce
uses: JuliaRegistries/[email protected]
with:
# GitHub API token
token:
# Owner/name of the registry repository
registry: # optional, default is JuliaRegistries/General
# URL of self-hosted GitHub
github: # optional, default is github.com
# API base URL of self-hosted GitHub
github_api: # optional, default is api.github.com
# Whether or not to merge release branches
branches: # optional
# Whether or not to create a repository dispatch event prior to making releases
dispatch: # optional
# Number of minutes to wait after creating a repository dispatch event
dispatch_delay: # optional, default is 5
# Number of days to look back in time for new releases
lookback: # optional, default is 3
# SSH private key for pushing tags
ssh: # optional
# Password for the SSH key
ssh_password: # optional
# GPG key for signing tags
gpg: # optional
# Password for the GPG key
gpg_password: # optional
# SSH private key for accessing a private registry
registry_ssh: # optional
# Create draft releases
draft: # optional
# Git username
user: # optional, default is github-actions[bot]
# Git email
email: # optional, default is 41898282+github-actions[bot]@users.noreply.github.com
# Branch to create releases against when possible
branch: # optional
# Subdirectory of package in repo, if not at top level
subdir: # optional
# Changelog template
changelog: # optional, default is ## {{ package }} {{ version }}

{% if previous_release %}
[Diff since {{ previous_release }}]({{ compare_url }})
{% endif %}

{% if custom %}
{{ custom }}
{% endif %}

{% if issues %}
**Closed issues:**
{% for issue in issues %}
- {{ issue.title }} (#{{ issue.number }})
{% endfor %}
{% endif %}

{% if pulls %}
**Merged pull requests:**
{% for pull in pulls %}
- {{ pull.title }} (#{{ pull.number }}) (@{{ pull.author.username }})
{% endfor %}
{% endif %}

# Labels for issues and pull requests to be ignored (comma-delimited)
changelog_ignore: # optional

name: TagBot
on:
issue_comment:
types:
- created
workflow_dispatch:
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}

4 comments on commit 9f722e6

@hhaensel
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/95626

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 9f722e6c1b35c61d85bb6d73a63f28acb455be99
git push origin v0.1.0

@hhaensel
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/95627

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 9f722e6c1b35c61d85bb6d73a63f28acb455be99
git push origin v0.1.0

Please sign in to comment.