Skip to content

Commit

Permalink
feat(meta): overhaul github actions, templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon-Becker committed Nov 12, 2023
1 parent 1449bb4 commit 61e011e
Show file tree
Hide file tree
Showing 6 changed files with 196 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug report
description: File a bug report
labels: ["T-bug"]
assignees:
- jon-becker
body:
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
Thanks for taking the time to report this bug!
- type: dropdown
attributes:
label: Component
description: What component is the bug in?
multiple: true
options:
- Bifrost
- Heimdall (Core)
- Heimdall (CLI)
- Other (please specify)
validations:
required: true
- type: checkboxes
attributes:
label: Have you ensured that you are up to date?
options:
- label: Bifrost
- label: Heimdall
- type: input
attributes:
label: What version of Heimdall are you on?
placeholder: "Run heimdall --version and paste the output here"
validations:
required: true
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux (ARM)
- Linux
- type: textarea
attributes:
label: Describe the bug
description: Please include as much detail as possible, including steps to reproduce the bug.
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature request
description: Request a new feature
labels: ["T-feature"]
body:
- type: markdown
attributes:
value: |
Please ensure that this feature has not already been requested in the issue tracker.
Thanks for taking the time to help improve Heimdall!
- type: dropdown
attributes:
label: Component
description: What component is the feature request for?
multiple: true
options:
- Bifrost
- Heimdall (Core)
- Heimdall (CLI)
- Other (please specify)
validations:
required: true
- type: textarea
attributes:
label: Describe the feature you would like
description: Please also describe what the feature is aiming to solve, if relevant.
validations:
required: true
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Question
description: Ask a general question about Heimdall
labels: ["T-question"]
body:
- type: markdown
attributes:
value: |
Please ensure that the question has not already been asked in the issue tracker, and that the wiki won't answer it.
- type: dropdown
attributes:
label: Component
description: What component is the question about?
multiple: true
options:
- Bifrost
- Heimdall (Core)
- Heimdall (CLI)
- Other (please specify)
validations:
required: true
- type: textarea
attributes:
label: Question
description: Please ask your question here.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Telegram
url: https://t.me/heimdallsupport
about: This issue tracker is only for bugs, feature requests, and questions about Heimdall.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--
Thank you for your Pull Request. Please provide a description above and review
the requirements below.
Bug fixes and new features should include tests.
-->

## Motivation

<!--
Explain the context and why you're making that change. What is the problem
you're trying to solve? In some cases there is not a problem and this can be
thought of as being the motivation for your change.
-->

## Solution

<!--
Summarize the solution and provide any necessary context needed to understand
the code change.
-->
64 changes: 64 additions & 0 deletions .github/workflows/dependencies.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Automatically run `cargo update` periodically

name: dependencies

on:
schedule:
# Run weekly
- cron: "0 0 * * SUN"
workflow_dispatch:
# Needed so we can run it manually

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: cargo-update
TITLE: "chore(deps): weekly `cargo update`"
BODY: |
Automation to keep dependencies in `Cargo.lock` current.
<details><summary><strong>cargo update log</strong></summary>
<p>
```log
$cargo_update_log
```
</p>
</details>
jobs:
update:
name: Update
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@nightly

- name: cargo update
# Remove first line that always just says "Updating crates.io index"
run:
cargo update --color never 2>&1 | sed '/crates.io index/d' | tee -a
cargo_update.log

- name: craft commit message and PR body
id: msg
run: |
export cargo_update_log="$(cat cargo_update.log)"
echo "commit_message<<EOF" >> $GITHUB_OUTPUT
printf "$TITLE\n\n$cargo_update_log\n" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
echo "body<<EOF" >> $GITHUB_OUTPUT
echo "$BODY" | envsubst >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT
- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
add-paths: ./Cargo.lock
commit-message: ${{ steps.msg.outputs.commit_message }}
title: ${{ env.TITLE }}
body: ${{ steps.msg.outputs.body }}
branch: ${{ env.BRANCH }}

0 comments on commit 61e011e

Please sign in to comment.