mantis-bug-tracker-action
Mantis Bug Tracker Issue Creation Using Github Actions â¨đ
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
âCITATION.cff file
Found CITATION.cff file -
âcodemeta.json file
Found codemeta.json file -
â.zenodo.json file
Found .zenodo.json file -
âDOI references
-
âAcademic publication links
-
âAcademic email domains
-
âInstitutional organization owner
-
âJOSS paper metadata
-
âScientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Keywords
Repository
Mantis Bug Tracker Issue Creation Using Github Actions â¨đ
Basic Info
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
- Releases: 13
Topics
Metadata Files
README.md
Automate issue creation on Mantis Bug Tracker with this GitHub action. It's free!
Usage Example
Place the following in /.github/workflows/mantisbt.yml
yml
on:
issues:
types: [opened]
name: đ Open Mantis Bug Tracker Issue
jobs:
open-issue:
name: đ Open MantisBT issue
runs-on: ubuntu-latest
steps:
- name: đ Open issue
uses: cipher-fox/mantis-bug-tracker-action@v1.0.0
with:
base-url: 'https://bt.mantis.com'
url: '/mantis/api/rest/issues'
token: ${{ secrets.MANTIS_BT_API_KEY }}
summary: ${{ github.event.issue.title }}
description: ${{ github.event.issue.body }}
project-id: '11'
category-id: '4'
Setup Steps
- Select the repository you want to add the action to
- Select the
Actionstab - Select
Blank workflow fileorSet up a workflow yourself, if you don't see these options manually create a yaml fileYour_Project/.github/workflows/mantisbt.yml - Paste the example above into your yaml file and save
- Now you need to add a key to the
secretssection in your project. To add asecretgo to theSettingstab in your project then selectSecrets. Add a newSecretforpassword - Update your yaml file settings
- If you appreciate this github action give it a :star: or show off with one of the badges below.
Settings
Keys can be added directly to your .yml config file or referenced from your project Secrets storage.
To add a secret go to the Settings tab in your project then select Secrets.
I strongly recommend you store your token as a secret.
Action options
| Key Name | Required | Example | Default Value | Description |
| ---------------- |----------|---------|---------------|-------------------------------------------|
| skip-required | No | true | false | Allow to skip the action required options |
HTTP client options
| Key Name | Required | Example | Default Value | Description |
| ---------------- | -------- | ------------------------- | ------------- | -------------------------------------------- |
| base-url | Yes | https://bt.mantis.com | null | The base url of the MantisBT instance |
| url | Yes | /mantis/api/rest/issues | / | The url resource of the MantisBT API |
| timeout | No | 4000 | 5000 | The http request timeout (ms) |
| proxy-type | No | https | null | The proxy protocol to use: HTTP or HTTPS |
| proxy-host | No | 127.0.0.1 | null | The proxy ip/address to use |
| proxy-port | No | 8080 | 8080 | The proxy port to use |
| proxy-username | No | root | null | The proxy username |
| proxy-password | No | toor | null | The proxy password |
MantisBT issue information
| Key Name | Required | Example | Default Value | Description |
|--------------------------|----------|------------------------------------| ------------- |-------------------------------------------------|
| token | Yes | s7dgs8s6a8fa8d68sdgdgi | null | The MantisBT API token |
| summary | Yes | Super Issue Title ⨠| null | The MantisBT issue summary field |
| pre-summary | No | SuperProject [FRONT] > | null | Prepend a text before the summary |
| description | Yes | Super Issue Description đ | null | The MantisBT issue description field |
| additional-information | No | Some Tiny Additional Information | null | The MantisBT issue additional information field |
| project-id | Yes | 11 | null | The MantisBT issue project id field |
| category-id | Yes | 4 | null | The MantisBT issue category id field |
| handler-name | No | me@test.com | null | The MantisBT issue handler name field |
| view-state-name | No | private | null | The MantisBT issue view state name field |
| priority-name | No | normal | null | The MantisBT issue priority name field |
| severity-name | No | trivial | null | The MantisBT issue severity name field |
| reproducibility-name | No | always | null | The MantisBT issue reproducibility name field |
| tags | No | git log front api | null | The MantisBT issue tags names field |
Check Mantis Bug Tracker API documentation on This Link
Outputs
This github action returns some variables once it has finished.
| Key Name | Example | Description |
| ----------- | ------------------------------------------------ | ---------------------- |
| issue-id | 00645 | The MantisBT issue id |
| issue-url | https://bt.mantis.com/mantis/view.php?id=00645 | The MantisBT issue url |
yml
on:
issues:
types: [opened]
name: đ Open Mantis Bug Tracker Issue
jobs:
open-issue:
name: đ Open MantisBT issue
runs-on: ubuntu-latest
steps:
- name: đ Open issue
id: mantisbt
uses: cipher-fox/mantis-bug-tracker-action@v1.0.0
with:
base-url: 'https://bt.mantis.com'
url: '/mantis/api/rest/issues'
token: ${{ secrets.MANTIS_BT_API_KEY }}
summary: ${{ github.event.issue.title }}
description: ${{ github.event.issue.body }}
project-id: '11'
category-id: '4'
- name: đ¤ Print output vars
run: echo "Issue ID ==> ${{ steps.mantisbt.outputs.issue-id }}" && \
echo "Issue URL ==> ${{ steps.mantisbt.outputs.issue-url }}"
Common Examples
Capture Github issue creation and publish it to MantisBT
```yml name: Capture Github issue and open new mantis bug tracker issue
on: issues: types: [opened]
jobs: main: runs-on: ubuntu-latest steps: - name: MantisBT Issue id: mantisbt uses: cipher-fox/mantis-bug-tracker-action@v1.0.0 with: base-url: 'https://bt.mantis.com' url: '/mantis/api/rest/issues' token: ${{ secrets.MANTISBTAPI_KEY }} summary: ${{ github.event.issue.title }} description: ${{ github.event.issue.body }} project-id: '11' category-id: '4' ```
Capture Github issue, publish to mantis and update github issue
```yml name: Open new mantis issue and update github issue
on: issues: types: [opened]
jobs:
main:
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- name: MantisBT Issue
id: mantisbt
uses: cipher-fox/mantis-bug-tracker-action@v1.0.0
with:
base-url: 'https://bt.mantis.com'
url: '/mantis/api/rest/issues'
token: ${{ secrets.MANTISBTAPIKEY }}
summary: ${{ github.event.issue.title }}
description: ${{ github.event.issue.body }}
project-id: '11'
category-id: '4'
- name: Add Mantis URL as Issue Comment
uses: peter-evans/create-or-update-comment@v3
with:
issue-number: ${{ github.event.issue.number }}
body: |
<a target="blank" href="${{ steps.mantisbt.outputs.issue-url }}">
```
Full example (all options) capturing Github issue, publish to mantis and update github issue
```yml name: Open new mantis issue and update github issue
on: issues: types: [opened]
jobs: main: runs-on: ubuntu-latest permissions: issues: write steps: - name: MantisBT Issue id: mantisbt uses: cipher-fox/mantis-bug-tracker-action@v1.0.0 with: base-url: 'https://bt.mantis.com' url: '/mantis/api/rest/issues' token: ${{ secrets.MANTISBTAPIKEY }} timeout: '5000' proxy-type: 'https' proxy-host: '127.0.0.1' proxy-port: '8080' proxy-username: 'root' proxy-password: 'toor' pre-summary: 'SuperProject-01 [FRONT] >' summary: ${{ github.event.issue.title }} description: ${{ github.event.issue.body }} additional-information: 'Super additional info đđđ' project-id: '11' category-id: '4' handler-name: 'hostmaster@localhost.com' view-state-name: 'public' priority-name: 'normal' severity-name: 'trivial' reproducibility-name: 'never' tags: |- issue github supertag front api back
- name: Add Mantis URL as Issue Comment
uses: peter-evans/create-or-update-comment@v3
with:
issue-number: ${{ github.event.issue.number }}
body: |
<a target="_blank" href="${{ steps.mantisbt.outputs.issue-url }}"><img src="https://i.imgur.com/vgIWfWf.png" alt="drawing" width="100"/></a>
```
Want another example? Let me know by creating a github issue
Badge
If you appreciate this github action give it a :star: or show off with one of the badges below. Feel free to edit the text or color.
Owner
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Jorge Gonzalez" given-names: "Marc" orcid: "https://orcid.org/0009-0000-7718-757X" title: "Mantis Bug Tracker Action" version: 1.1.0 date-released: 2023-07-26 url: "https://github.com/cipher-fox/mantis-bug-tracker-action"
GitHub Events
Total
- Release event: 1
- Delete event: 1
- Push event: 2
- Pull request event: 1
- Create event: 2
Last Year
- Release event: 1
- Delete event: 1
- Push event: 2
- Pull request event: 1
- Create event: 2