From ad9b331f32dccaee714338ac065a8297bcc14522 Mon Sep 17 00:00:00 2001 From: Caleb Jasik Date: Thu, 27 Mar 2025 16:37:15 -0500 Subject: [PATCH] Split into README, DEVELOPING, RELEASING files --- CONTRIBUTING.md => DEVELOPING.md | 18 ++---------------- README.md | 2 -- RELEASING.md | 16 ++++++++++++++++ 3 files changed, 18 insertions(+), 18 deletions(-) rename CONTRIBUTING.md => DEVELOPING.md (66%) create mode 100644 RELEASING.md diff --git a/CONTRIBUTING.md b/DEVELOPING.md similarity index 66% rename from CONTRIBUTING.md rename to DEVELOPING.md index 3d78d99..2cdcecb 100644 --- a/CONTRIBUTING.md +++ b/DEVELOPING.md @@ -2,7 +2,7 @@ ## Setting up dev environment -Install all of the following things: +Install all the following things: - [`xcode`](https://apps.apple.com/us/app/xcode/) - use the version specified by `xcode_select` in `/ios/fastlane/Fastfile` - [`android-studio`](https://developer.android.com/studio) @@ -28,7 +28,7 @@ Run `flutter doctor` and fix everything it complains before proceeding If you are having issues with iOS pods, try blowing it all away! `cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update` -# Formatting +## Formatting `dart format` can be used to format the code in `lib` and `test`. We use a line-length of 120 characters. @@ -39,17 +39,3 @@ dart format lib/ test/ -l 120 In Android Studio, set the line length using Preferences → Editor → Code Style → Dart → Line length, set it to 120. Enable auto-format with Preferences → Languages & Frameworks → Flutter → Format code on save. -# Prerelease - -Push a git tag `v#.#.#-##`, e.g. `v0.5.1-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track. - -`./swift-format.sh` can be used to format Swift code in the repo. - -Once `swift-format` supports ignoring directories (), we can move to a method of running it more like what describes. - -# Release - -1. Manually promote a prerelease build from TestFlight and Android internal track to the corresponding public app stores. -2. Mark the associated draft release as published, removing the `-##` from it, ending with a release in the format `v#.#.#`, e.g. `v0.5.1`. -3. Remove the old draft releases that will never be published. -4. Add the notable changes to the app to the release summary, e.g.: . \ No newline at end of file diff --git a/README.md b/README.md index 2a7b518..5103028 100644 --- a/README.md +++ b/README.md @@ -7,5 +7,3 @@ Nebula is an overlay networking tool designed to be fast, secure, and scalable. Mobile Nebula brings this functionality to devices running Android and iOS. This code is **source-available** meaning that the source is provided for viewing, but we are **not accepting contributions** and provide no license past what the [GitHub Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service#5-license-grant-to-other-users) permit. - -See [contributing](CONTRIBUTING.md) for dev-related instructions if you are a Defined Networking employee. \ No newline at end of file diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..51bcabd --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,16 @@ +# Releasing + +## Prerelease + +Push a git tag `v#.#.#-##`, e.g. `v0.5.1-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track. + +`./swift-format.sh` can be used to format Swift code in the repo. + +Once `swift-format` supports ignoring directories (), we can move to a method of running it more like what describes. + +## Release + +1. Manually promote a prerelease build from TestFlight and Android internal track to the corresponding public app stores. +2. Mark the associated draft release as published, removing the `-##` from it, ending with a release in the format `v#.#.#`, e.g. `v0.5.1`. +3. Remove the old draft releases that will never be published. +4. Add the notable changes to the app to the release summary, e.g.: . \ No newline at end of file