https://github.com/actionstoolbox/caretaker-action
A GitHub action to run the caretaker changelog tool.
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.8%) to scientific vocabulary
Repository
A GitHub action to run the caretaker changelog tool.
Basic Info
- Host: GitHub
- Owner: ActionsToolbox
- License: mit
- Language: Shell
- Default Branch: master
- Size: 42 KB
Statistics
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Caretaker
Inputs
| Name | Required | Default Value | Details | | ------------------- | -------- | --------------------------------------------- | --------------------------------------------------------- | | git-push-user-name | false | github-actions[bot] | The name of the person used for the git commit. | | git-push-user-email | false | github-actions[bot]@users.noreply.github.com | The email used for the git commit. Required if using GPG. | | git-commit-message | false | chore: caretaker action | The commit message to use. | | gpg-passphrase | false | | Passphrase for the GPG key. | | gpg-private-key | false | | GPG private key for signing the published artifacts. | | output-file | false | CHANGELOG.md | The name of the changelog file. | | args | false | | Additional arguments to pass to the command. |
args are currently silently ignored
Example usage
Basic
The following configuration will run caretaker and commit the new changelog to the master branch, however this commits will be unsigned.
```yaml name: Caretaker
on: push: branches: - master tags: - 'v*'
jobs: caretaker: runs-on: ubuntu-latest name: Caretaker steps: - name: Check our repo uses: actions/checkout@v3 with: fetch-depth: 0 - name: Caretaker uses: ActionsToolbox/caretaker-action@master ```
Signed Comiits
The following configuration will do exactly the same as the basic example onlt this time the commits will be signed.
Never use your personal GPG keys for automated tools, create one that is dedicated for this purpose!
```yaml name: Caretaker
on: push: branches: - master tags: - 'v*'
jobs: caretaker: runs-on: ubuntu-latest name: Caretaker steps: - name: Check our repo uses: actions/checkout@v3 with: fetch-depth: 0 - name: Caretaker id: caretaker uses: ActionsToolbox/caretaker-action@master with: gpg-private-key: ${{ secrets.GPGPRIVATEKEY }} gpg-passphrase: ${{ secrets.GPGPASSPHRASE }} git-push-user-email: ${{ secrets.GPGEMAIL }}
```
Owner
- Name: Actions Toolbox
- Login: ActionsToolbox
- Kind: organization
- Email: github@wolfsoftware.com
- Location: United Kingdom
- Website: https://wolfsoftware.com
- Twitter: wolfsoftware
- Repositories: 6
- Profile: https://github.com/ActionsToolbox
A collection of GitHub actions. Created by Wolf Software.
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 0
- Total pull requests: 20
- Average time to close issues: N/A
- Average time to close pull requests: about 2 months
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.6
- Merged pull requests: 19
- Bot issues: 0
- Bot pull requests: 19
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (19)
- lupraxus (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ActionsToolbox/caretaker-action master composite
- actions/checkout v3 composite
- Gamesight/slack-workflow-status v1.2.0 composite
- actions/checkout v3 composite
- ruby/setup-ruby v1 composite
- Mattraks/delete-workflow-runs v2 composite
- dependabot/fetch-metadata v1.3.6 composite
- GitGuardian/ggshield-action master composite
- actions/checkout v3 composite
- actions/first-interaction v1 composite
- actions/stale v7 composite
- otto-contentfactory/purge-workflow-runs v1 composite
- wolfsoftwareltd/caretaker 0.0.1 build
- Dockerfile * docker