Skip to content

Commit 83fd3a5

Browse files
committed
docs(CONTRIBUTING): add release instructions
1 parent 03c6e73 commit 83fd3a5

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

CONTRIBUTING.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -109,21 +109,34 @@ The release proceeds through three sequential steps: [Pre-Release Process](#pre-
109109
## Pre-Release Process
110110

111111
The pre-release process is as follows:
112-
- TODO
113-
114-
The `pre-release.yml` workflow will automatically create a GitHub release, build the library, and add the artifact to GitHub.
112+
- Check if the latest FusionAuth version is used in the different jobs and configurations.
113+
- Review, test and merge any open [Dependency Pull Requests](https://github.com/sonderformat-llc/fusionauth-swift-sdk/pulls).
114+
- Update the documentation with `sourcedocs generate -- -scheme FusionAuth`.
115+
- Make sure all Workflows where successful in [Actions](https://github.com/FusionAuth/fusionauth-android-sdk/actions).
116+
- Update the [SECURITY.md](SECURITY.md) version information with the latest `Supported Versions` according to the current specification E2E test workflows and prerelease PR.
117+
- Approve and merge the prerelease PR with the rc tag (release candidate) once all actions run successfully.
118+
- Make sure all Prerelease-Workflows where successful in [Actions](https://github.com/FusionAuth/fusionauth-android-sdk/actions).
115119

116120
## Release Process
117121

118122
The release process is as follows:
119-
- TODO
120-
121-
The `release.yml` workflow will automatically create a GitHub release, build the library, and publish it to Maven Central.
123+
- Check if a prerelease run successfully, if not start with the pre-release process.
124+
- Update the release version in the `library/build.gradle.kts` file, derived from the pre-release version according to the [Semantic Versioning](https://semver.org/) guidelines.
125+
- Make sure all Workflows where successful in [Actions](https://github.com/FusionAuth/fusionauth-android-sdk/actions).
126+
- Update the [SECURITY.md](SECURITY.md) version information with the latest `Supported Versions` according to the current specification E2E test workflows and release PR.
127+
- Approve and merge the release PR once all actions run successfully.
128+
- Make sure all Release-Workflows where successful in [Actions](https://github.com/FusionAuth/fusionauth-android-sdk/actions).
122129

123130
### Quickstart Release Process
124131

125132
After the release is published, update the version in the [FusionAuth Swift iOS Quickstart Repository](https://github.com/sonderformat-llc/fusionauth-quickstart-swift-ios-native/):
126-
- TODO
133+
134+
The example App is a copy from https://github.com/sonderformat-llc/fusionauth-swift-sdk/tree/main/Samples/Quickstart by:
135+
136+
1. Copy the Samples/Quickstart folder in to the complete-application folder.
137+
2. edit the complete-application/fusionauth-quickstart-swift-ios-native.xcodeproj/project.pbxproj file, removing the Packages and sdk references.
138+
3. open the project and add the sdk dependency by adding the latest release from https://github.com/sonderformat-llc/fusionauth-swift-sdk/.
139+
5. update the docker-compose.yml file to use the latest version used by the sdk.
127140
<!--
128141
end::forDocSiteRelease[]
129142
-->

0 commit comments

Comments
 (0)