Skip to content

Commit 038369a

Browse files
helinaneverzgoldie
andauthored
Publishing category restructure (#3425)
* Update configuration and content files to enhance publishing categories and menu structure - Modified `config.yaml` to introduce new menu items for tester distribution, publishing to stores, and static hosting. - Updated multiple content files to associate them with the newly created menu categories for better organization, including Firebase App Distribution, GitHub Releases, and various store publishing guides. - Adjusted sidebar template logic to ensure proper rendering of menu items based on the new structure. * Refactor publishing categories in configuration and content files - Updated `config.yaml` to rename and reorganize menu items related to publishing, including changes from "Tester distribution" to "Publishing" and "Distributing". - Modified multiple content files to reflect the new menu categories, ensuring proper association with the updated structure for Firebase App Distribution, GitHub Releases, and various store publishing guides. - Enhanced organization of publishing-related documentation for better clarity and accessibility. * Restructure YAML/Flutter docs to match sidebar sections by content folder - Remove menuCategories from all pages; sidebar lists pages by Hugo section only - Move distributing guides to yaml-distributing/ and flutter-distributing/ - Duplicate iOS device provisioning into yaml-testing/ and flutter-testing/; remove custom-menu-position; alias /testing/ios-provisioning on YAML copy - Add aliases on moved pages for old yaml-publishing / flutter-publishing URLs - Move pub.dev under yaml-distributing with alias for previous path - Simplify breadcrumbs (no menuCategories branch) * Update links and aliases in Flutter documentation - Corrected the link in the tip section of flutter-projects.md to point to the updated path for distributing packages on pub.dev. - Added an alias in pub.dev.md to maintain compatibility with the previous publishing URL. * Move build dashboards to distribution * Update weights * Update category names * Revert frontend changes --------- Co-authored-by: zgoldie <hello@zachgoldie.com> Co-authored-by: zgoldie <73491442+zgoldie@users.noreply.github.com>
1 parent e18a3d2 commit 038369a

28 files changed

Lines changed: 815 additions & 39 deletions

config.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,22 @@ menu:
6767
parent: yaml
6868
weight: 4
6969
- identifier: yaml-publishing
70-
name: Publishing
70+
name: Publishing to the stores
7171
parent: yaml
7272
weight: 5
73+
- identifier: yaml-distributing
74+
name: Build distribution
75+
parent: yaml
76+
weight: 6
7377
- identifier: yaml-notification
7478
name: Notifications
7579
parent: yaml
76-
weight: 6
80+
weight: 7
7781

7882
- identifier: integrations
7983
name: Integrations
8084
parent: yaml
81-
weight: 7
85+
weight: 8
8286
- identifier: knowledge-base
8387
name: Advanced configuration
8488
weight: 8
@@ -131,10 +135,14 @@ menu:
131135
name: Publishing
132136
parent: flutter
133137
weight: 5
138+
- identifier: flutter-distributing
139+
name: Distributing
140+
parent: flutter
141+
weight: 6
134142
- identifier: flutter-notification
135143
name: Notifications
136144
parent: flutter
137-
weight: 6
145+
weight: 7
138146

139147

140148

content/billing/pricing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ If you need to support older versions of your application and need access to old
288288

289289
You can download build artifacts via the Codemagic UI or using the [Codemagic REST API](../rest-api/builds/).
290290

291-
To keep copies of your future build artifacts, we advise you to set up publishing to external storage, see an example [here](../yaml-publishing/aws/).
291+
To keep copies of your future build artifacts, we advise you to set up publishing to external storage, see an example [here](../yaml-distributing/aws/).
292292

293293
### Instance Types
294294

content/flutter-configuration/flutter-projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ aliases:
1313
With Codemagic, you can build and test Flutter apps for Android, iOS, web, macOS and Linux as well as [test widgets](../testing/testing-widgets). It is also possible to set up a [workflow](../flutter/creating-workflows) that runs tests only.
1414

1515
{{<notebox>}}
16-
**Tip:** If you're interested in building Flutter/Dart packages and publishing them to [pub.dev](https://pub.dev/), you can do so with [`codemagic.yaml`](../getting-started/yaml), see an example [here](../yaml-publishing/pub.dev).
16+
**Tip:** If you're interested in building Flutter/Dart packages and publishing them to [pub.dev](https://pub.dev/), you can do so with [`codemagic.yaml`](../getting-started/yaml), see an example [here](../yaml-distributing/pub.dev).
1717
{{</notebox>}}
1818

1919
## Selecting build platforms and build machines

content/flutter-testing/app-preview.md renamed to content/flutter-distributing/app-preview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ title: Previewing apps in the browser
33
description: Test your iOS or Android app in the browser with App Preview
44
weight: 4
55
aliases:
6+
- /flutter-testing/app-preview
67
---
78

89
App Preview is our iOS simulator and Android emulator running in your browser. Launch and interact with your iOS or Android app right in the browser, regardless of the operating system you are using. Test your app against different device and OS configurations, emulate GPS location or demo the latest app version without needing access to a physical device.
910

1011
{{< youtube l1VeZXtO0zQ >}}
1112

12-
**Tip:** The following sections describe creating previewable artifacts using Flutter Workflow Editor. If you're using codemagic.yaml, follow the instructions [here](../yaml-testing/app-preview).
13+
**Tip:** The following sections describe creating previewable artifacts using Flutter Workflow Editor. If you're using codemagic.yaml, follow the instructions [here](../yaml-distributing/app-preview).
1314

1415
## Enabling App Preview and Free Trial
1516

content/knowledge-others/build-dashboards.md renamed to content/flutter-distributing/build-dashboards.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ weight: 3
55
aliases:
66
- /knowledge-base/shared-dashboards
77
- /knowledge-base/public-dashboards
8+
- /knowledge-others/build-dashboards
89
---
910

1011
Build dashboards make it possible for teams to share the list of team's builds, release notes (if passed) and build artifacts with people outside Codemagic using a public link (build logs will not be exposed). This is a convenient option for distributing builds to testers or sharing build artifacts with stakeholders.

content/flutter-publishing/firebase-app-distribution.md renamed to content/flutter-distributing/firebase-app-distribution.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,21 @@ description: Deploy a Flutter app to Firebase App Distribution using the Flutter
33
title: Firebase App Distribution with Flutter workflow editor
44
linkTitle: Firebase App Distribution
55
weight: 5
6-
aliases: /publishing/firebase-app-distribution
6+
aliases:
7+
- /publishing/firebase-app-distribution
8+
- /flutter-publishing/firebase-app-distribution
79
---
810

911
Set up publishing to [Firebase App Distribution](https://firebase.google.com/docs/app-distribution) to distribute your Android and iOS apps to testers.
1012

1113
{{<notebox>}}
12-
**Note:** This guide only applies to workflows configured with the **Flutter workflow editor**. If your workflow is configured with **codemagic.yaml**, please go to [Publishing an app to Firebase App Distribution](../yaml-publishing/firebase-app-distribution).
14+
**Note:** This guide only applies to workflows configured with the **Flutter workflow editor**. If your workflow is configured with **codemagic.yaml**, please go to [Publishing an app to Firebase App Distribution](../yaml-distributing/firebase-app-distribution).
1315
{{</notebox>}}
1416

1517
## Requirements
1618

1719
- [Add Firebase to your Flutter project](https://firebase.google.com/docs/flutter/setup)
18-
- Generate a [Firebase token](https://firebase.google.com/docs/cli#cli-ci-systems) locally or set up a [service account](https://docs.codemagic.io/yaml-publishing/firebase-app-distribution/#requirements) with **Firebase App Distribution Admin** role to authenticate with Firebase App Distribution.
20+
- Generate a [Firebase token](https://firebase.google.com/docs/cli#cli-ci-systems) locally or set up a [service account](https://docs.codemagic.io/yaml-distributing/firebase-app-distribution/#requirements) with **Firebase App Distribution Admin** role to authenticate with Firebase App Distribution.
1921
- If your app uses Firebase services, you need to upload the Firebase configuration files to Codemagic, see the instructions [here](/knowledge-base/load-firebase-configuration/).
2022
- Set up [iOS code signing](../code-signing/ios-code-signing). Note that an Ad Hoc or Enterprise distribution profile is required to distribute the app outside your development team.
2123
- Set up [Android code signing](../code-signing/android-code-signing). If you do not set up code signing, the artifact will be signed with a debug keystore from Codemagic build machine.

content/flutter-publishing/github-releases.md renamed to content/flutter-distributing/github-releases.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ description: How to create a GitHub release with artifacts using the Flutter wor
33
title: GitHub releases with Flutter workflow editor
44
linkTitle: GitHub releases
55
weight: 9
6-
aliases: /publishing/github-release/
6+
aliases:
7+
- /publishing/github-release/
8+
- /flutter-publishing/github-releases
79
---
810

911
Codemagic enables you to create a GitHub release automatically and upload generated artifacts when your build is triggered on tag creation. Read more about GitHub releases in [GitHub's documentation](https://docs.github.com/en/github/administering-a-repository/about-releases).

content/flutter-publishing/publishing-to-aws.md renamed to content/flutter-distributing/publishing-to-aws.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: How to publish a web app to Amazon S3 using Flutter workflow editor
33
title: Amazon S3 publishing using Flutter workflow editor
44
linkTitle: Amazon S3
55
weight: 8
6+
aliases:
7+
- /flutter-publishing/publishing-to-aws
68
---
79

810
In order to publish your web application to AWS S3:

content/flutter-publishing/publishing-to-codemagic-static-pages.md renamed to content/flutter-distributing/publishing-to-codemagic-static-pages.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
description: How to publish a web app to a custom subdomain using the Flutter workflow editor
33
title: Codemagic Static Pages
44
weight: 7
5-
aliases: /publishing/publishing-to-codemagic-static-pages
5+
aliases:
6+
- /publishing/publishing-to-codemagic-static-pages
7+
- /flutter-publishing/publishing-to-codemagic-static-pages
68
---
79

810
You can publish your web app to a custom subdomain of `codemagic.app` for easy access.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ linkTitle: Code Push with Shorebird
55
meta_title: Publish Flutter Apps with Shorebird OTA Updates
66
meta_description: Integrate Shorebird with Codemagic to publish Flutter apps and deliver over-the-air updates from CI/CD workflows.
77
weight: 4
8-
aliases:
8+
aliases:
9+
- /flutter-publishing/shorebird
910
---
1011

1112
Code push for Flutter is a cloud service by [Shorebird](https://shorebird.dev/) that allows developers to push over-the-air (OTA) app updates directly to users' devices without publishing each update on app stores. With Codemagic, you can use Shorebird to build and publish a release or a patch for Android and iOS.

0 commit comments

Comments
 (0)