Skip to content

Commit

Permalink
Merge branch 'eclipse-pass:main' into prune-infra-docs-sm
Browse files Browse the repository at this point in the history
  • Loading branch information
steven-exarcos authored Sep 20, 2024
2 parents 5b4e777 + aba9344 commit f9c43a3
Show file tree
Hide file tree
Showing 12 changed files with 325 additions and 41 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Bug Report Issue
about: A standard Bug Report template and the types of information that should be captured in a Bug Report issue.
title: ''
labels: 'bug'
assignees: ''

---

# Prerequisites

Please answer the following questions for yourself before submitting a Bug Report issue:
* Is the title clear and understandable at a glance?
* Should any other labels be added to this issue?

Labels are not required for all tickets, but they are helpful for prioritization. Please check the labels drop-down to see if any of the pre-set labels work for your ticket.

**YOU SHOULD DELETE THE PREREQUISITES SECTION.**

# Environment

Indicate the environment that the bug was realized. This can also be more than the environment and may include the following: OS, browser, local/dev/staging/prod etc.

# Date/time occurred

Indicate the date/time the bug was realized.

# Description

What is the problem? Describe what is currently happening in detail.

# Steps to Reproduce

What are the steps performed to reproduce this bug?

# Expected Results

What are the expected results? What is the expected behavior?

# Actual Results

What are the actual results and provide any evidence of the actual results below.

# Evidence

Please provide screenshots/screen capture or other evidence such as log files (scrubbed of sensitive information).

# Estimated Severity

If possible, provide an initial severity estimate of the issue. This of course can be adjusted after submission.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-request-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Enhancement Request Issue
about: A standard Enhancement Request template and the types of information that should be captured in a Enhancement Request issue.
title: ''
labels: 'Improvement'
assignees: ''

---

# Prerequisites

Please answer the following questions for yourself before submitting an Enhancement Request issue:
* Is the title clear and understandable at a glance?
* Should any other labels be added to this issue?

Labels are not required for all tickets, but they are helpful for prioritization. Please check the labels drop-down to see if any of the pre-set labels work for your ticket.

**YOU SHOULD DELETE THE PREREQUISITES SECTION.**

# Description

A description of the enhancement. What are the new features/improvements to this enhancement change?

# Value

Why is this enhancement important/valuable?

# Users/Target Audience

Who would benefit from this enhancement?

# Requirements

If known, what are the dependencies and infrastructure required for this enhancement?

# Examples

Are there any current examples of this feature somewhere else? Please provide screenshots or URLs of this enhancement.

# Risks

Are there any risks that may be associated with this enhancement? For example, cost, time, performance impact or increased complexity?
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/release-checklist-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Release Checklist Issue
about: PASS Release Checklist includes all the necessary steps required to successfully release the next version of PASS.
title: 'Release MAJOR.MINOR.PATCH'
labels: 'Release'
assignees: ''

---

# Release Manager Actions Checklist

| | |
|------------------|----------------------------|
| Release version | MAJOR.MINOR.PATCH |
| Next dev version | MAJOR.MINOR.PATCH-SNAPSHOT |

## Release Process Overview
This is the full detailed release process, including the steps that are performed by the GitHub automation: [Release](https://github.com/eclipse-pass/main/blob/main/docs/dev/release.md)

## Pre-release

- [] Identify the version to be utilized for the release.
- [] Ensure all code commits and PRs intended for the release have been merged.
- [] Issue a code freeze statement on the Eclipse PASS slack #pass-dev channel to notify all developers that a release is imminent.

[Release Steps with Automations](https://github.com/eclipse-pass/main/blob/main/docs/dev/release-steps-with-automations.md)

## Release Projects

[Release All Modules Workflow](https://github.com/eclipse-pass/main/actions/workflows/pass-complete-release.yml)

- [] Release Main
- [] Release Pass-Core
- [] Release Pass Support
- [] Release Pass UI
- [] Release Pass Acceptance Testing
- [] Release Pass Docker

## Post-release

- [] Test the release by using the [acceptance test workflow](https://github.com/eclipse-pass/pass-acceptance-testing/actions/workflows/test.yml). Enter the release number into the Ref field.
- [] Check that correct tickets are in the release milestone. [GitHub Ticket Update](https://github.com/eclipse-pass/main/blob/main/docs/dev/release.md#update-release-notes)
- [] Write release notes in the [Release Notes doc](https://github.com/eclipse-pass/main/blob/main/docs/release-notes.md), submit a PR for the changes, and ensure the PR is merged. Release Notes should be written to be understandable by community members who are not technical.
- [] Draft release message and have technical & community lead provide feedback. Ensure that a link to the release notes is included in the release message.
- [] Post a message about the release to the PASS Google Group. [Notes about the PASS Google Group](https://github.com/eclipse-pass/main/blob/main/docs/dev/release.md#process)
- [] Update [Pass Demo](https://demo.eclipse-pass.org) to new release - [Publish to SNS Topic action](https://github.com/eclipse-pass/main/actions/workflows/deployToAWS.yml) using `Environment: demo`
- [] Send message to Eclipse PASS slack #pass-dev channel that the release is complete.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Build yarn module for release
name: Build package module for release
description: |
Build yarn module
Build package module
inputs:
repository_dir:
Expand All @@ -17,18 +17,18 @@ inputs:
runs:
using: composite
steps:
- name: Builds yarn module
- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 9
- name: Builds module
shell: bash
working-directory: ${{ inputs.repository_dir }}
env:
ENV_FILE_PATH: ${{ inputs.env_path }}
IS_DEV: ${{ inputs.is_dev }}
run: |
export $(grep -v '^[#|SIGNING|PASS_CORE_POLICY]' $ENV_FILE_PATH | xargs -d '\n')
yarn install --frozen-lockfile
if [ "$IS_DEV" == "true" ]; then
yarn run build:dev
else
yarn run build
fi
yarn run build:docker
pnpm install --frozen-lockfile
pnpm run build
pnpm run build:docker
33 changes: 33 additions & 0 deletions .github/actions/node-version/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Update package version for release
description: |
Updates package version which automatically does a commit and this action tags
inputs:
repository_dir:
description: 'Directory of repository to update'
required: true
skip_tag:
description: 'Skip git tag'
required: false
default: "false"

runs:
using: composite
steps:
- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 9
- name: Update version and tag
shell: bash
working-directory: ${{ inputs.repository_dir }}
env:
SKIP_TAG: ${{ inputs.skip_tag }}
run: |
pnpm install --frozen-lockfile
pnpm version --git-tag-version false --new-version $RELEASE
git commit --allow-empty -am "Update version to $RELEASE"
if [ "$SKIP_TAG" == "false" ]; then
echo "Tagging version $RELEASE"
git tag $RELEASE
fi
2 changes: 1 addition & 1 deletion .github/actions/yarn-version/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ runs:
if [ "$SKIP_TAG" == "false" ]; then
echo "Tagging yarn version $RELEASE"
git tag $RELEASE
fi
fi
38 changes: 9 additions & 29 deletions .github/workflows/pass-complete-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ jobs:
git clone https://${{ secrets.JAVA_RELEASE_PAT }}@github.com/eclipse-pass/pass-acceptance-testing.git combined/pass-acceptance-testing
git clone https://${{ secrets.JAVA_RELEASE_PAT }}@github.com/eclipse-pass/pass-docker.git combined/pass-docker
- name: Setup Node & Yarn
uses: actions/setup-node@v3
- name: Setup Node & pnpm
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20

- name: Login to GHCR
uses: docker/login-action@v2
Expand Down Expand Up @@ -115,6 +115,7 @@ jobs:
docker push ghcr.io/eclipse-pass/jhu-grant-loader:$RELEASE
docker push ghcr.io/eclipse-pass/pass-journal-loader:$RELEASE
docker push ghcr.io/eclipse-pass/pass-nihms-loader:$RELEASE
docker push ghcr.io/eclipse-pass/pass-nihms-token-refresh:$RELEASE
- name: Set Snapshot/commit ~ Java Repositories
if: ${{ ! env.ALL_JAVA_REPOS_TAG_EXISTS }}
Expand Down Expand Up @@ -143,6 +144,7 @@ jobs:
docker push ghcr.io/eclipse-pass/jhu-grant-loader:$NEXT
docker push ghcr.io/eclipse-pass/pass-journal-loader:$NEXT
docker push ghcr.io/eclipse-pass/pass-nihms-loader:$NEXT
docker push ghcr.io/eclipse-pass/pass-nihms-token-refresh:$NEXT
- name: Push the commits and tags ~ Java Repositories
if: ${{ ! env.ALL_JAVA_REPOS_TAG_EXISTS }}
Expand All @@ -166,15 +168,15 @@ jobs:

- name: Set Release/commit/tag ~ pass-ui
if: ${{ ! env.PASS_UI_TAG_EXISTS }}
uses: ./main/.github/actions/yarn-version
uses: ./main/.github/actions/node-version
with:
repository_dir: combined/pass-ui
env:
RELEASE: ${{ env.RELEASE }}

- name: Build Release pass-ui
if: ${{ ! env.PASS_UI_TAG_EXISTS }}
uses: ./main/.github/actions/yarn-build
uses: ./main/.github/actions/node-build
with:
repository_dir: combined/pass-ui
env_path: ../pass-docker/.env
Expand All @@ -185,7 +187,7 @@ jobs:

- name: Set Snapshot/commit ~ pass-ui
if: ${{ ! env.PASS_UI_TAG_EXISTS }}
uses: ./main/.github/actions/yarn-version
uses: ./main/.github/actions/node-version
with:
repository_dir: combined/pass-ui
skip_tag: "true"
Expand All @@ -194,7 +196,7 @@ jobs:

- name: Build Snapshot pass-ui
if: ${{ ! env.PASS_UI_TAG_EXISTS }}
uses: ./main/.github/actions/yarn-build
uses: ./main/.github/actions/node-build
with:
repository_dir: combined/pass-ui
env_path: ../pass-docker/.env
Expand Down Expand Up @@ -251,35 +253,13 @@ jobs:
git commit --allow-empty -am "Update version to $RELEASE"
git tag --force $RELEASE
- name: Build Release pass-docker images
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
working-directory: combined/pass-docker
run: docker compose -f docker-compose.yml -f eclipse-pass.local.yml build idp ldap

- name: Push Release Docker images to GHCR ~ pass-docker
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
run: |
docker push ghcr.io/eclipse-pass/demo-ldap:$RELEASE
docker push ghcr.io/eclipse-pass/idp:$RELEASE
- name: Set Snapshot/commit ~ pass-docker
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
run: |
cd combined/pass-docker
sed -i "/^PASS_VERSION/s/.*/PASS_VERSION=$NEXT/" .env
git commit --allow-empty -am "Update version to $NEXT"
- name: Build Snapshot pass-docker images
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
working-directory: combined/pass-docker
run: docker compose -f docker-compose.yml -f eclipse-pass.local.yml build idp ldap

- name: Push Snapshot Docker images to GHCR ~ pass-docker
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
run: |
docker push ghcr.io/eclipse-pass/demo-ldap:$NEXT
docker push ghcr.io/eclipse-pass/idp:$NEXT
- name: Push the commits and tags ~ pass-docker
if: ${{ ! env.PASS_DOCKER_TAG_EXISTS }}
run: cd combined/pass-docker && git push --atomic origin main --force $RELEASE
Expand Down
51 changes: 51 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
## Release v1.10.0
### Date: August 28, 2024

Release Manager: Russ Poetker, JHU

This release focused on a new Deposit Services repository integration, NIHMS Data Loader automation, and Release process and Documentation improvements. Deposit services has been enhanced to be able to deposit into InvenioRDM. This can also be tested locally with pass-docker being able to start a local instance of InvenioRDM. There is a new automation available in NIHMS Data Loader for refreshing the NIHMS API Token. We made a change to the pass-core/pass-support releases to align the maven repackage plugin configuration with its latest recommendations. As part of this change, the repackaged jar file is no longer deployed to Maven Central during release. The team continued work on overhauling and improving the existing documentation.

Tickets Completed: https://github.com/eclipse-pass/main/milestone/24?closed=1

Release Components:
* main - https://github.com/eclipse-pass/main/releases/tag/1.10.0
* pass-core - https://github.com/eclipse-pass/pass-core/releases/tag/1.10.0
* pass-docker - https://github.com/eclipse-pass/pass-docker/releases/tag/1.10.0
* pass-acceptance-testing - https://github.com/eclipse-pass/pass-acceptance-testing/releases/tag/1.10.0
* pass-support - https://github.com/eclipse-pass/pass-support/releases/tag/1.10.0
* pass-ui - https://github.com/eclipse-pass/pass-ui/releases/tag/1.10.0

## Release v1.9.1
### Date: August 1, 2024

Release Manager: Russ Poetker, JHU

This release fixes a bug with the layout of some of the pages in the UI.

Tickets Completed: https://github.com/eclipse-pass/main/milestone/25?closed=1

Release Components:
* main - https://github.com/eclipse-pass/main/releases/tag/1.9.1
* pass-core - https://github.com/eclipse-pass/pass-core/releases/tag/1.9.1
* pass-docker - https://github.com/eclipse-pass/pass-docker/releases/tag/1.9.1
* pass-acceptance-testing - https://github.com/eclipse-pass/pass-acceptance-testing/releases/tag/1.9.1
* pass-support - https://github.com/eclipse-pass/pass-support/releases/tag/1.9.1
* pass-ui - https://github.com/eclipse-pass/pass-ui/releases/tag/1.9.1

## Release v1.9.0
### Date: July 31, 2024

Release Manager: Russ Poetker, JHU

This release focused on improving deployment tests, addressing technical debt, and improving documentation. Deployment tests were updated to make deposits into downstream repositories optional. If a deployment test deposit is made into a downstream DSpace repository, it will be automatically deleted after the test completes. More deprecations in pass-ui were fixed which allowed pass-ui to be upgraded to Ember v5.8. The pass-ui module now uses Embroider and pnpm for building. The team continued work on overhauling the existing documentation.

Tickets Completed: https://github.com/eclipse-pass/main/milestone/23?closed=1

Release Components:
* main - https://github.com/eclipse-pass/main/releases/tag/1.9.0
* pass-core - https://github.com/eclipse-pass/pass-core/releases/tag/1.9.0
* pass-docker - https://github.com/eclipse-pass/pass-docker/releases/tag/1.9.0
* pass-acceptance-testing - https://github.com/eclipse-pass/pass-acceptance-testing/releases/tag/1.9.0
* pass-support - https://github.com/eclipse-pass/pass-support/releases/tag/1.9.0
* pass-ui - https://github.com/eclipse-pass/pass-ui/releases/tag/1.9.0

## Release v1.8.0
### Date: July 1, 2024

Expand Down
3 changes: 3 additions & 0 deletions docs/release/release-actions-1.10.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Release Manager Actions Checklist Template

- Release tracked in GitHub issue: https://github.com/eclipse-pass/main/issues/1039
Loading

0 comments on commit f9c43a3

Please sign in to comment.