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.

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

Update documentation for release 1.1.0 #807

Merged
merged 5 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## Release v1.1.0
### Date: October 26, 2023

This release focused on getting PASS ready for deployment in production. We did a great deal of testing of the user interface, backend services, and interactions with repositories. We found and fixed a large number of bugs. We significantly improved the performance of grant loading. We made accessibility improvements to the user interface. In addition, we added support for depositing to repositories without requiring a journal be entered by the user.

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

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

## Release v1.0.0
### Date: September 29, 2023

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

| | |
| --- | --- |
| Release version | 1.1.0 |
| Next dev version | 1.2.0-SNAPSHOT |

## Release Process Overview
This is the full detailed release process, including the steps that are performed by the GitHub automation: [Release](../dev/release.md)

## Pre-release

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

## Release Java Projects
[Release Steps with Automations](../dev/release-steps-with-automations.md)

Release Workflow Example: [Triggering a GitHub workflow](../dev/release-steps-with-automations.md#triggering-a-gitHub-workflow)

- [x] Release Main - [Main Release workflow](https://github.com/eclipse-pass/main/actions/workflows/release.yml)
- [x] Verify Main Artifacts on Maven Central - [Main Artifacts on Maven Central](https://central.sonatype.com/artifact/org.eclipse.pass/eclipse-pass-parent)
- [x] Main GitHub Release Page - Perform after the Main release is complete - [Main GitHub Release Page](https://github.com/eclipse-pass/main/releases)

---

- [x] Release Pass-Core - [Pass-Core Release workflow](https://github.com/eclipse-pass/pass-core/actions/workflows/release.yml)
- [x] Verify Pass-Core Artifacts on Maven Central - [Pass-Core Artifacts on Maven Central](https://central.sonatype.com/artifact/org.eclipse.pass/pass-core)
- [x] Pass-Core GitHub Release Page - Perform after the Pass Core release is complete - [Pass Core GitHub Release Page](https://github.com/eclipse-pass/pass-core/releases)

---

- [x] Release Pass Support - [Pass Support Release workflow](https://github.com/eclipse-pass/pass-support/actions/workflows/release.yml)
- [x] Verify Pass Support Artifacts on Maven Central - [Pass Support Artifacts on Maven Central](https://central.sonatype.com/artifact/org.eclipse.pass/pass-support)
- [x] Pass Support GitHub Release Page - Perform after the Pass Support release is complete - [Pass Support GitHub Release Page](https://github.com/eclipse-pass/pass-support/releases)

## Release Non-Java Projects

- [x] Release Pass UI - [Pass UI workflow](https://github.com/eclipse-pass/pass-ui/actions/workflows/release.yml)
- [x] Verify Pass UI packages [Pass UI Packages](https://github.com/eclipse-pass/pass-ui/pkgs/container/pass-ui)
- [x] Pass UI Release Page - Perform after the Pass UI release is complete - [Pass UI GitHub Release Page](https://github.com/eclipse-pass/pass-ui/releases)

---

- [x] Release Pass Auth - [Pass Auth workflow](https://github.com/eclipse-pass/pass-auth/actions/workflows/release.yml)
- [x] Verify Pass Auth packages [Pass Auth Packages](https://github.com/eclipse-pass/pass-auth/pkgs/container/pass-auth)
- [x] Pass Auth Release Page - Perform after the Pass Auth release is complete - [Pass Auth GitHub Release Page](https://github.com/eclipse-pass/pass-auth/releases)

---

- [x] Release Pass Acceptance Testing - [Pass Acceptance Testing workflow](https://github.com/eclipse-pass/pass-acceptance-testing/actions/workflows/release.yml)
- [x] Verify Pass Acceptance Testing Tag [Pass Acceptance Testing Tag](https://github.com/eclipse-pass/pass-acceptance-testing/tags)
- [x] Pass Acceptance Testing Release Page - Perform after the Pass Acceptance Testing release is complete - [Pass Acceptance Testing GitHub Release Page](https://github.com/eclipse-pass/pass-acceptance-testing/releases)

## Release Other Projects
Note: This must be released last because it relies on some Docker images that will be published during the release process.

- [x] Release Pass Docker - Select checkbox for acceptance tests - [Release workflow](https://github.com/eclipse-pass/pass-docker/actions/workflows/release.yml)
- [x] Pass Docker Release Page - Perform after the Pass Docker release is complete - [Pass Docker GitHub Release Page](https://github.com/eclipse-pass/pass-docker/releases)

## Post-release

- [x] Test the release by using the newly updated pass-docker to run the release locally.
- [x] Check that correct tickets are in the release milestone. [Github Ticket Update](../dev/release.md#update-release-notes)
- [x] Write release notes in the [Release Notes doc](../release-notes.md), update the [Roadmap](../roadmap.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.
- [x] Draft release message and have technical & community lead provide feedback. Ensure that a link to the release notes is included in the release message.
- [x] Post a message about the release to the PASS Google Group. [Notes about the PASS Google Group](../dev/release.md#process)
- [x] Update template if any steps were missed or if any new tasks were added. Also make note of these new steps in the release-actions-X.X.X.md file.
- [x] 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`
- [x] Send message to Eclipse PASS slack #pass-dev channel that the release is complete.
21 changes: 9 additions & 12 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,15 @@ If you are interested in helping to define and/or contribute to this roadmap, pl

# [Completed Releases](release-notes.md)

## 1.1.0
This release will have a continued focus on the production readiness of the project and see the first production partner institution (JHU) go live.
* Ensure that the full stack, including deposit services, is functioning with production repositories
* Fix any bugs remaining after the 1.0.0 release in the user interface, backend services, and API
* Refine accessibility for the user interface

## 1.2.0
This release will focus on the setup and improvement of application testing environments as well as moving towards greater codebase language consistency.
* Harmonize Integration Test setup - updating the method for executing integration tests to ensure consistent and streamlined launch and execution
* Addition of system tests - adding a mechanism and tests to support full-system verification
This release will focus on updating integrations with external services and ensuring that those operating and maintaining the PASS application have the information needed to understand system activity
* Update the NIH Manuscript Submission client to the latest specification
* Update the grant loader to support Fibi, the new grant database at JHU
* Address technical debt and improve documentation in order to prepare for potential partners
* Improve logging configuration to ensure logging is captured and utilized consistently across the project
* Define, capture, and expose metrics required for understanding performance, system utilization, and discovering errors

## 1.3.0
This release will focus on ensuring that those operating and maintaining the PASS application have the information needed to visualize system activity
* Logging improvement - ensure logging is configured, captured, and utilized consistently across the project
* Monitoring and observability - define, capture, and expose metrics required for understanding performance, system utilization, and tracking errors
This release will focus on deposit system integrations and preparation for an upcoming administrative console
* Integrating top priority repository systems to support additional deposit endpoints
* API additions that will be used to support an administrative user interface
Loading