Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Action to sync release notes with nebari-docs #1554

Merged
merged 6 commits into from
Nov 30, 2022
+42 −7
Merged

Action to sync release notes with nebari-docs #1554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
247b8e5
Add Note about QHub->Nebari rename in old docs (#1543)
pavithraes Nov 15, 2022
21db764
🔄 Synced file(s) with nebari-dev/.github (#1550)
nebari-sensei Nov 17, 2022
cab1c3b
🔄 Synced file(s) with nebari-dev/.github (#1551)
nebari-sensei Nov 17, 2022
0f2c011
action to sync release notes with nebari-docs
pavithraes Nov 18, 2022
7d1fc6d
update RELEASE.md headers, add note about qhub
pavithraes Nov 18, 2022
7431c6d
Merge branch 'release/2022.11.1' into release-notes-sync
pavithraes Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/release-notes-sync-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Configuration for ./workflows/release-notes-sync
# Ref: https://github.com/BetaHuhn/repo-file-sync-action

group:
repos: nebari-dev/nebari-docs
files:
- source: RELEASE.md
dest: docs/reference/RELEASE.md
21 changes: 21 additions & 0 deletions .github/workflows/release-notes-sync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Sync release notes with nebari.dev/docs

on:
release:
types: [created]
workflow_dispatch:

jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@master
- name: Run Release File Sync ♻️
uses: BetaHuhn/repo-file-sync-action@v1
with:
GH_PAT: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member Author

@pavithraes pavithraes Nov 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Does secrets.GITHUB_TOKEN have permission to nebari-dev/nebari-docs?
If not, do we need a new secret for this?

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure but we can update this in the future should it fail 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

@iameskild Looks like it doesn't have access, ref: https://github.com/nebari-dev/nebari/actions/runs/3597037385/jobs/6058376405#step:3:15

I see we use secrets.GH_PAT in nebari-dev/.github -- @trallard is this secrets.GH_PAT an org-level secret that we can use here? If not, we can create a new secret with the required scope.

CONFIG_PATH: .github/release-notes-sync-config.yaml
COMMIT_BODY: "MAINT - Sync release notes :robot:"
PR_LABELS: |
type: file sync ♻️
20 changes: 13 additions & 7 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Changelog
# Release notes

> Contains description of QHub releases.
*Contains description of Nebari releases.*

______________________________________________________________________
<!-- Note:
The RELEASE.md file at the root of the Nebari codebase is the source of truth for all release notes.
If you want to update the release notes, open a PR against nebari-dev/nebari.
This file is copied to nebari-dev/nebari-docs using a GitHub Action. -->

---

## Upcoming Release

Expand Down Expand Up @@ -38,10 +43,11 @@ Although breaking changes are never fun, the Nebari development team believes th
* Update `skip_remote_state_provision` default value by @viniciusdc in https://github.com/nebari-dev/nebari/pull/1521
* Add release notes for 2022.10.1 in https://github.com/nebari-dev/nebari/pull/1523

## New Contributors
### New Contributors
* @pavithraes made their first contribution in https://github.com/nebari-dev/nebari/pull/1503
* @FFY00 made their first contribution in https://github.com/nebari-dev/nebari/pull/1509

**Note: The following releases (v0.4.5 and lower) were made under the name `Quansight/qhub`.**

## Release v0.4.5 - October 14, 2022

Expand All @@ -64,10 +70,10 @@ Enhancements for this release include:
* Update traefik version + CRD by @iameskild in https://github.com/Quansight/qhub/pull/1489
* [ENH] Switch default and filesystem name envs by @viniciusdc in https://github.com/Quansight/qhub/pull/1357

## New Contributors
### New Contributors
* @tjcrone made their first contribution in https://github.com/Quansight/qhub/pull/1471

## Migration note
### Migration note

If you are upgrading from a version of Nebari prior to `0.4.5`, you will need to manually update your conda-store namespaces
to be compatible with the new Nebari version. This is a one-time migration step that will need to be performed after upgrading to continue using the service. Refer to [How to migrate base conda-store namespaces](https://deploy-preview-178--nebari-docs.netlify.app/troubleshooting#conda-store-compatibility-migration-steps-when-upgrading-to-045) for further instructions.
Expand Down Expand Up @@ -119,7 +125,7 @@ Enhancements for this release include:
* Pin dask ipywidgets version to `7.7.1` by @viniciusdc in https://github.com/Quansight/qhub/pull/1442
* Set qhub-dask version to 0.4.4 by @iameskild in https://github.com/Quansight/qhub/pull/1470

## New Contributors
### New Contributors
* @konkapv made their first contribution in https://github.com/Quansight/qhub/pull/1424

## Release v0.4.3 - July 7, 2022
Expand Down