Skip to content

Commit

Permalink
Release version 1.0.0-rc2 to main
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelosalloum committed Aug 31, 2023
1 parent 2987418 commit e376690
Show file tree
Hide file tree
Showing 8 changed files with 153 additions and 16 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Bug report
about: Tell us about a bug you found
title: ""
labels: bug
assignees: ""
---

<!-- Please answer these questions before submitting your issue. Thanks! -->

### What version are you using?

### What did you do?

### What happened?

### What did you expect to see instead?
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Backend Project
url: https://github.com/stellar/stellar-disbursement-platform-backend
about: The backend API where this repository's application integrates with.
- name: Stellar Laboratory
url: https://laboratory.stellar.org/#?network=test
about: The best place to experiment with the Stellar network.
- name: Docker Images
url: https://hub.docker.com/r/stellar/stellar-disbursement-platform-frontend
about: Where to check the available Docker images that have been published.
- name: Stellar Ecosystem Proposals (SEPs)
url: https://github.com/stellar/stellar-protocol
about: The SEPs implemented in this project are defined here.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature request
about: Tell us what you'd like to see
title: "Feature Request: "
labels: ""
assignees: ""
---

<!-- Please answer these questions before submitting your issue. Thanks! -->

### What problem does your feature solve?

### What would you like to see?

### What alternatives are there?
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/release_a_new_version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Release a New Version!
about: Prepare a release to be launched
title: ""
labels: release
---

<!-- Please Follow this checklist before making your release. Thanks! -->

## Release Checklist

> Attention: the examples below use the version `x.y.z` but you should update
> them to use the version you're releasing.
### Git Preparation

- [ ] Decide on a version number based on the current version number and the
common rules defined in [Semantic Versioning](https://semver.org). E.g.
`x.y.z`.
- [ ] Update this ticket name to reflect the new version number, following the
pattern "Release `x.y.z`".
- [ ] Cut a branch for the new release out of the `develop` branch, following
the gitflow naming pattern `release/x.y.z`.

### Code Preparation

- [ ] Update the project's version in [package.json] accordingly.
- [ ] Update the [CHANGELOG.md] with the new version number and release notes.
- [ ] Run tests and linting, and make sure the version running in the default
branch is working end-to-end. At least the minimal end-to-end manual tests
is mandatory.
- [ ] 🚨 DO NOT RELEASE before holidays or weekends! Mondays and Tuesdays are
preferred.

### Merging the Branches

> 🚨 ATTENTION: in the following steps, do `merge commits` and NOT
> `squash-and-merge`!
- [ ] When the team is confident the release is stable, you'll need to create
two pull requests:
- [ ] `release/x.y.z -> main`: This PR should be merged with a merge commit.
- [ ] `release/x.y.z -> develop`: this should be merged after the `main`
branch is merged. This PR should be merged with a merge commit.

### Publishing the Release

- [ ] After the release branch is merged to `main`, create a new release on
GitHub with the name `x.y.z` and the use the same changes from the
[CHANGELOG.md] file.
- [ ] The release should automatically publish a new version of the docker
image to Docker Hub. Double check if that happened.

[package.json]:
https://github.com/stellar/stellar-disbursement-platform-frontend/blob/develop/package.json
[CHANGELOG.md]:
https://github.com/stellar/stellar-disbursement-platform-frontend/blob/develop/CHANGELOG.md
57 changes: 45 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,57 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [1.0.0](https://github.com/stellar/stellar-relief-backoffice/tree/1.0.0)
## Unreleased

> Place unreleased changes here.
## [1.0.0.rc2](https://github.com/stellar/stellar-disbursement-platform-backend/compare/1.0.0-rc1...1.0.0-rc2)

### Added

- The payment detail to display the cash-out status per payment.
- The account status to be able to track the cash-out status per account.
- Support for a 2-step approval for the disbursement, where one user creates the
disbursement and another approves it.
[#1](https://github.com/stellar/stellar-disbursement-platform-frontend/pull/1),
[#3](https://github.com/stellar/stellar-disbursement-platform-frontend/pull/3)
- Support to edit receivers.
[#5](https://github.com/stellar/stellar-disbursement-platform-frontend/pull/5)
- Support for changing the password without resorting to the "fogot password"
flow.
[#6](https://github.com/stellar/stellar-disbursement-platform-frontend/pull/6)

### Updated
### Changed

- The account & disbursement detail pages to display the amount cashed-out per
account and per disbursement.
- Readme instructions.
[#2](https://github.com/stellar/stellar-disbursement-platform-frontend/pull/2)

## {version} < 1.0.0
## [1.0.0.rc1](https://github.com/stellar/stellar-disbursement-platform-frontend/releases/tag/1.0.0-rc1)

### Added:
### Added

- Disbursements list & detail.
- Beneficiaries (accounts) list & detail.
- Payments per disbursement detail and per account detail.
First Release Candidate of the Stellar Disbursement Platform, a tool used to
make bulk payments to a list of recipients based on their phone number and a
confirmation date. This repository is frontend-only, is a client to the backend
version available at [stellar/stellar-disbursement-platform-backend]. Their
version numbers are meant to be kept in sync.

The basic process of this product starts with an organization supplying a CSV
file which includes the recipients' phone number, transfer amount, and essential
customer validation data such as the date of birth.

The platform subsequently sends an SMS to the recipient, which includes a deep
link to the wallet. This link permits recipients with compatible wallets to
register their wallet on the SDP. During this step, they are required to verify
their phone number and additional customer data through the SEP-24 interactive
deposit flow, where this data is shared directly with the backend through a
webpage inside the wallet, but the wallet itself does not have access to this
data.

Upon successful verification, the SDP backend will transfer the funds directly
to the recipient's wallet. When the recipient's wallet has been successfully
associated with their phone number in the SDP, all subsequent payments will
occur automatically.

[stellar/stellar-disbursement-platform-backend]:
https://github.com/stellar/stellar-disbursement-platform-backend
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stellar-relief-backoffice",
"version": "1.0.0",
"name": "stellar-disbursement-platform-frontend",
"version": "1.0.0-rc2",
"license": "Apache-2.0",
"engines": {
"node": ">=18.x"
Expand Down Expand Up @@ -77,7 +77,7 @@
"production": "yarn prod:build && yarn prod:serve",
"prepare": "husky install",
"pre-commit": "concurrently 'pretty-quick --staged' 'lint-staged' 'tsc --noEmit'",
"git-info": "rm -rf src/generated/ && mkdir src/generated/ && echo export default \"{\\\"commitHash\\\": \\\"$(git rev-parse --short HEAD)\\\"};\" > src/generated/gitInfo.ts"
"git-info": "rm -rf src/generated/ && mkdir src/generated/ && echo export default \"{\\\"commitHash\\\": \\\"$(git rev-parse --short HEAD)\\\", \\\"version\\\": \\\"$(git describe --tags --always)\\\"};\" > src/generated/gitInfo.ts"
},
"eslintConfig": {
"extends": [
Expand Down
1 change: 1 addition & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export const App = () => {
useEffect(() => {
// Git commit hash
console.log("current commit hash: ", GitInfo.commitHash);
console.log("version: ", GitInfo.version);
}, []);

return (
Expand Down
2 changes: 1 addition & 1 deletion src/generated/gitInfo.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export default { commitHash: "5386816" };
export default { commitHash: "5386816", version: "1.0.0-rc2" };

0 comments on commit e376690

Please sign in to comment.