backstage / backstage/actions

[feature request] create an action that checks for backstage updates

Open
#124 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
24
Forks
23
Avg merge
12h 5m
Merged PRs (30d)
7

Description

using the `backstage-cli` makes updating backstage straightforward and easy, it would be nice to have an action that does that automatically in a periodic manner.

I created a workflow that runs every month to check for new versions and creates a PR with the changes:

```yaml
name: Update Backstage
on:
workflow_dispatch: {}
schedule:
- cron: '0 0 1 * *'
jobs:
update-backstage:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v3

- name: Retrieve node version
id: node-version
run: echo "node=$(cat .node-version)" >> $GITHUB_OUTPUT

- name: install Node.js
uses: actions/setup-node@v3
with:
node-version: ${{ steps.node-version.outputs.node }}
cache: 'npm'

- name: install dependencies
run: npm install --global yarn

- name: yarn install
uses: backstage/actions/yarn-install@v0.6.3
with:
cache-prefix: ${{ runner.os }}-v${{ matrix.node-version }}

- name: Update Backstage
run: yarn backstage-cli versions:bump --pattern '@{backstage,roadiehq,k-phoen}/*'

- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "chore(deps): updates Backstage"
title: "chore(deps): updates Backstage"
branch: chore/update-backstage
body: Please additionally have a look at [upgrade-helper](https://backstage.github.io/upgrade-helper/) tool from Backstage to compare if there is changes to the upstream project and adapt accordingly.
```

I am willing to submit a pull request here if the maintainers approve.

Cheers

Contributor guide

No contributing guide indexed for this repository

Research direction

Start from the supplied monthly workflow, especially the backstage-cli versions:bump command and the create-pull-request step. Define the action's interface and periodic-update behavior, then verify that it can check for Backstage updates and create the requested pull request; the issue does not name repository files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.