From bf512335fe9939131cbe8508975530258f7d796b Mon Sep 17 00:00:00 2001 From: Mohammed Babelly Date: Wed, 18 Oct 2023 09:57:44 +0300 Subject: [PATCH] Renaming `owner` role name to `admin` (#2125) * Renaming `owner` role name to `admin` * fixing typos * delete users.md partial * Update content/yaml-running-builds/starting-builds-automatically.md Co-authored-by: helinanever <36853001+helinanever@users.noreply.github.com> * Remove FWE webhook config --------- Co-authored-by: helinanever <36853001+helinanever@users.noreply.github.com> --- content/billing/billing.md | 6 ++--- .../custom-menu-position/ios-provisioning.md | 2 +- .../publishing-to-microsoft-store.md | 2 +- content/getting-started/teams.md | 17 ++++++------- content/partials/bitbucket.md | 2 +- content/partials/github.md | 4 +-- content/partials/gitlab.md | 2 +- .../integrations-setup-app-store-connect.md | 2 +- content/partials/modifying-access.md | 2 +- content/partials/other.md | 2 +- content/partials/users.md | 25 ------------------- content/rest-api/applications.md | 4 +-- content/rest-api/teams.md | 7 +++--- content/yaml-code-signing/signing-android.md | 2 +- content/yaml-code-signing/signing-ios.md | 2 +- content/yaml-publishing/build-dashboards.md | 4 +-- .../starting-builds-automatically.md | 4 +-- 17 files changed, 31 insertions(+), 58 deletions(-) delete mode 100644 content/partials/users.md diff --git a/content/billing/billing.md b/content/billing/billing.md index 9435a640b..55707c6c4 100644 --- a/content/billing/billing.md +++ b/content/billing/billing.md @@ -46,14 +46,14 @@ For pay-as-you-go team and user plans, each build minute is billed at the rate o ## Overdue and failed invoice payments -Invoices that have not been paid on the due date are shown as "Overdue" or "Failed" on the [Billing](https://codemagic.io/billing/) page. This usually happens when there are problems with charging the card, of which team or account owners are notified by email. Codemagic will then attempt to retry the payment in 3, 5 or 7 days. +Invoices that have not been paid on the due date are shown as "Overdue" or "Failed" on the [Billing](https://codemagic.io/billing/) page. This usually happens when there are problems with charging the card, of which team admins or account owners are notified by email. Codemagic will then attempt to retry the payment in 3, 5 or 7 days. As soon as there is a failed invoice payment, your subscription will be put on hold and running builds will be disabled. In order to continue building, all invoices should be paid. -Team or account owners can manually retry the payment by clicking the **Pay invoice** button on the overdue/pending invoice in **Billing history**. This will redirect you to the Stripe-based payment website where you are required to add your credit card details and click **Make Payment**. +Team admins or account owners can manually retry the payment by clicking the **Pay invoice** button on the overdue/pending invoice in **Billing history**. This will redirect you to the Stripe-based payment website where you are required to add your credit card details and click **Make Payment**. {{}} -**Pending invoices**: Some invoices may remain pending due to issues with the payment. This can happen when international payments on your card are disabled or when automatic payments are not allowed in which case the first payment has to be made manually to comply with the new RBI regulations for Indian cardholders. Team or account owners can then manually retry the payment as described above. +**Pending invoices**: Some invoices may remain pending due to issues with the payment. This can happen when international payments on your card are disabled or when automatic payments are not allowed in which case the first payment has to be made manually to comply with the new RBI regulations for Indian cardholders. Team admins or account owners can then manually retry the payment as described above. {{}} Note that overdue invoices should be paid before the subscription can be disabled. Please refer to the [Disable billing](/billing/billing/#disabling-billing) section for further info. diff --git a/content/custom-menu-position/ios-provisioning.md b/content/custom-menu-position/ios-provisioning.md index e71f87324..5290c1046 100644 --- a/content/custom-menu-position/ios-provisioning.md +++ b/content/custom-menu-position/ios-provisioning.md @@ -18,7 +18,7 @@ You can also check the [Register Devices](https://help.apple.com/developer-accou ## Requirements -* You have to be a team owner to manage iOS test devices. +* You have to be a team admin to manage iOS test devices. * The **Apple Developer Portal integration** must be connected in **Team integrations** to be able to register new devices. This requires creating an App Store Connect API key with **Developer** permissions, see how to create one [here](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api). ## Creating a tester group diff --git a/content/flutter-publishing/publishing-to-microsoft-store.md b/content/flutter-publishing/publishing-to-microsoft-store.md index 95742a709..65ff307bb 100644 --- a/content/flutter-publishing/publishing-to-microsoft-store.md +++ b/content/flutter-publishing/publishing-to-microsoft-store.md @@ -32,7 +32,7 @@ Follow the instructions [here](../knowledge-base/partner-center-authentication) ### Step 2. Connecting the Microsoft Partner Center integration for your team/account -The Microsoft Partner Center integration can be enabled in **Teams > Personal Account > Integrations** for personal projects and in **Teams > Your Team Name > Team integrations** for projects shared in the team (if you're the team owner). This allows you to conveniently use the same access credentials for publishing across different apps and workflows. +The Microsoft Partner Center integration can be enabled in **Teams > Personal Account > Integrations** for personal projects and in **Teams > Your Team Name > Team integrations** for projects shared in the team (if you're a team admin). This allows you to conveniently use the same access credentials for publishing across different apps and workflows. 1. In the list of available integrations, click the **Connect** button for **Partner Center**. 2. In the **Tenant name** field, provide a name for the set of credentials you are going to set up the integration with. This is for identifying the set of credentials in Codemagic. diff --git a/content/getting-started/teams.md b/content/getting-started/teams.md index 6f8a444cb..f6ff4ab7c 100644 --- a/content/getting-started/teams.md +++ b/content/getting-started/teams.md @@ -26,7 +26,7 @@ To create a new team: 4. Click **Next: Add payment details**. You will be then asked to add your credit card details and company information (if relevant) to enable billing for the team. 5. Then click **Finish: Create team** to enable billing and continue setting up the team. -Once the team has been created, team owners can change the team's name, add or remove shared applications, add or remove users, change user roles and manage billing. +Once the team has been created, team admins can change the team's name, add or remove shared applications, add or remove users, change user roles and manage billing. {{}}**Note:** Keep in mind to review the filter settings on the Applications page to see your newly created team and shared team apps.{{}} @@ -34,7 +34,7 @@ Once the team has been created, team owners can change the team's name, add or r To add or remove shared applications, click on **Shared applications** to see the list of available applications. Check the repositories you wish to share with your team and uncheck the ones you wish to remove. Once done, click **Save changes**. -{{}}**Note:** Unless you set up a repository integration in [Team integrations](#managing-team-integrations), Codemagic will use the primary team owner's credentials for accessing the repositories.{{}} +{{}}**Note:** Unless you set up a repository integration in [Team integrations](#managing-team-integrations), Codemagic will use the primary team admin's credentials for accessing the repositories.{{}} ## Inviting team members @@ -48,13 +48,13 @@ To remove any team members, click on the three dots next to their name and selec Users in Codemagic teams can have one of the three roles. -* **Owner**. The user creating a team will become a team owner by default and has full access to all team, app, and repository settings. Other members of the team can be upgraded to owners as well. Owners can select the repositories to be shared with the team, invite new team members, change their roles or remove existing members, including other team owners, manage team integrations and billing. +* **Admin**. (previously called **Owner**) The user creating a team will become a team admin by default and has full access to all team, app, and repository settings. Other members of the team can be upgraded to admins as well. Admins can select the repositories to be shared with the team, invite new team members, change their roles or remove existing members, including other team admins, manage team integrations and billing. * **Member**. A user with this role has access to the Codemagic UI and can view team settings, configure app settings and trigger new builds. Members cannot modify any team settings, billing details, or repository settings other than the app name. * **User**. Any user that triggers builds from a webhook but does not have access to the team in Codemagic UI. -Owners can upgrade members to owners by clicking on the three dots next to their name and selecting **Upgrade to owner**, or downgrade other owners by selecting **Downgrade to member**. +Admins can upgrade members to admins by clicking on the three dots next to their name and selecting **Upgrade to admin**, or downgrade other admins by selecting **Downgrade to member**. Users that have triggered builds can be invited to the team by clicking **Add to team** on the email address in the list of users. @@ -66,7 +66,7 @@ The build dashboards feature makes it possible to share the team's builds and bu In Team integrations, it is possible to set up integrations to be used with team apps. -Unless team owners have connected an integration in team settings, team creator's credentials are used to access repository information. It is advisable to configure access to the shared repositories on the team level in the **Team integrations** section. Set up an integration with a service where your repositories are hosted by clicking **Connect** next to its name. +Unless team admins have connected an integration in team settings, team creator's credentials are used to access repository information. It is advisable to configure access to the shared repositories on the team level in the **Team integrations** section. Set up an integration with a service where your repositories are hosted by clicking **Connect** next to its name. ## Managing billing @@ -74,13 +74,10 @@ Billing is managed separately for each team. Read more about billing [here](../b ## Leaving the team -A team member can leave the team at any time by clicking **Leave team** in the lower part of the page. If the only team owner wants to leave the team, they first have to upgrade another member to the owner role or delete the team completely. +A team member can leave the team at any time by clicking **Leave team** in the lower part of the page. If the only team admin wants to leave the team, they first have to upgrade another member to the admin role or delete the team completely. ## Deleting the team -Only the team owner can delete the team. To do so, scroll down to the **Danger zone** and click **Delete team**. +Only the team admin can delete the team. To do so, scroll down to the **Danger zone** and click **Delete team**. {{}}**Note:** Teams can only be deleted if they are empty (no members or shared applications) and billing has been disabled.{{}} - - - \ No newline at end of file diff --git a/content/partials/bitbucket.md b/content/partials/bitbucket.md index 826b13135..eda5daad6 100644 --- a/content/partials/bitbucket.md +++ b/content/partials/bitbucket.md @@ -10,7 +10,7 @@ For the best integration with the Git provider, it’s recommended to connect yo Adding apps from Bitbucket requires granting access to your Bitbucket account to enable the integration and load repositories. 1. Click **Add application** in the top right corner of the Applications page. -2. If you are an owner of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. +2. If you are an admin in a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. 3. Select **Bitbucket** as the Git provider and click **Next: Authorize integration**. A new window appears for you to authorize Codemagic. Confirm the authorization by clicking **Grant access**. If you have already authorized Bitbucket, click **Next: Select repository** instead. 4. Set up the application by selecting the repository from the dropdown menu and specifying the project type. Click **Finish: Add application**. You will be then redirected to the app settings. diff --git a/content/partials/github.md b/content/partials/github.md index d94de8f15..a0632f0e2 100644 --- a/content/partials/github.md +++ b/content/partials/github.md @@ -10,7 +10,7 @@ For the best integration with the Git provider, it’s recommended to connect yo Adding apps from GitHub requires authorizing Codemagic and installing the Codemagic CI/CD GitHub App to a GitHub account or an organization to be able to load the repositories. 1. Click **Add application** in the top right corner of the Applications page. -2. If you are an owner of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. +2. If you are an admin of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. 3. Select **GitHub** as the Git provider. If you have already set up the integration, click **Next: Select repository** and skip to step 4. If the GitHub integration has not been set up, you'll see click **Next: Authorize integration** instead. A new window appears for you to authorize Codemagic. Confirm the authorization by clicking **Authorize Codemagic CI/CD**. 4. In the next step, click **Install GitHub App** to set up the integration. A GitHub page opens in a new window. Select the account or an organization where to install the app and choose whether to give Codemagic access to all the repositories from this account or only selected ones. Finish the installation by clicking **Install & Authorize**. 5. Finally, set up the application by selecting the repository from the dropdown menu and specifying the project type. Click **Finish: Add application**. You will be then redirected to the app settings. @@ -22,7 +22,7 @@ Adding apps from GitHub requires authorizing Codemagic and installing the Codema Codemagic uses the [Codemagic CI/CD GitHub App](https://github.com/apps/codemagic-ci-cd) to integrate with GitHub. To share your GitHub repositories with Codemagic, Codemagic GitHub App will have to be installed on the account or organization in GitHub from which you would like to build applications. {{}} -**Note:** The GitHub App integration can be connected separately for your personal account and each team. The integrations configured for your personal account apply to the apps that are not part of a team in Codemagic. While teams inherit the integrations from the team owner's personal account, it is highly recommended to set up repository integrations separately in team settings. +**Note:** The GitHub App integration can be connected separately for your personal account and each team. The integrations configured for your personal account apply to the apps that are not part of a team in Codemagic. While teams inherit the integrations from the team admin's personal account, it is highly recommended to set up repository integrations separately in team settings. {{}}

{{}} diff --git a/content/partials/gitlab.md b/content/partials/gitlab.md index 9f2d1c4f6..8a28a63da 100644 --- a/content/partials/gitlab.md +++ b/content/partials/gitlab.md @@ -10,7 +10,7 @@ For the best integration with the Git provider, it’s recommended to connect yo Adding apps from GitLab requires granting access to your GitLab account to enable the integration and load repositories. 1. Click **Add application** in the top right corner of the Applications page. -2. If you are an owner of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. +2. If you are an admin of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. 3. Select **GitLab** as the Git provider and click **Next: Authorize integration**. A new window appears for you to authorize Codemagic. Confirm the authorization by clicking **Authorize**. If you have already authorized GitLab, click **Next: Select repository** instead. 4. Set up the application by selecting the repository from the dropdown menu and specifying the project type. Click **Finish: Add application**. You will be then redirected to the app settings. diff --git a/content/partials/integrations-setup-app-store-connect.md b/content/partials/integrations-setup-app-store-connect.md index e3d326f51..75cc8b907 100644 --- a/content/partials/integrations-setup-app-store-connect.md +++ b/content/partials/integrations-setup-app-store-connect.md @@ -1,4 +1,4 @@ -The Apple Developer Portal integration can be enabled in **Teams > Personal Account > Integrations** for personal projects and in **Teams > Your Team Name > Team integrations** for projects shared in the team (if you're the team owner). This allows you to conveniently use the same access credentials for automatic code signing and publishing across different apps and workflows. +The Apple Developer Portal integration can be enabled in **Teams > Personal Account > Integrations** for personal projects and in **Teams > Your Team Name > Team integrations** for projects shared in the team (if you're a team admin). This allows you to conveniently use the same access credentials for automatic code signing and publishing across different apps and workflows. 1. In the list of available integrations, click the **Connect** button for **Developer Portal**. 2. In the **App Store Connect API key name**, provide a name for the key you are going to set up the integration with. This is for identifying the key in Codemagic. diff --git a/content/partials/modifying-access.md b/content/partials/modifying-access.md index adcc0fa55..749ed4482 100644 --- a/content/partials/modifying-access.md +++ b/content/partials/modifying-access.md @@ -7,7 +7,7 @@ aliases: Navigate to **App settings > Repository settings** to update repository access settings, change the app name or icon in Codemagic, archive or delete the app. -Note that if the app is part of a team, only team owners can update repository access settings or delete the app. +Note that if the app is part of a team, only team admins can update repository access settings or delete the app. ## Updating access to the repository diff --git a/content/partials/other.md b/content/partials/other.md index c938d03b6..93c5e278a 100644 --- a/content/partials/other.md +++ b/content/partials/other.md @@ -11,7 +11,7 @@ Apps that cannot be added via a repository integration can be cloned from a URL. ## Connecting repository via SSH 1. Click **Add application** in the top right corner of the Applications page. -2. If you are an owner of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. +2. If you are an admin of a team in Codemagic, you'll be asked to **Select a team**. You can only add the application to a team that has billing enabled. If you don't own any teams, this step is skipped and the application will be added to your personal account. 3. Select **Other** and click **Next: Select repository**. 4. Enter the **Repository URL** for **cloning** the repository. You can find the URL from your repository by clicking **Clone** / **Clone or download**. Usually, the URL is in this format: `git@example.com:username/repo.git`. 5. Upload the **SSH private key** file. If your key is password-protected, enter the **Private key passphrase**. diff --git a/content/partials/users.md b/content/partials/users.md deleted file mode 100644 index bc72d8b7c..000000000 --- a/content/partials/users.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Counting users in teams -weight: 2 ---- - -## Active users - -An active user is anyone who triggers a build manually from the Codemagic UI, via the API, or automatically from a webhook in response to events in the repository. Active users are marked with a green badge with the build count on it. The number of active users for the ongoing subscription period is shown on the right sidebar in team settings. - -The active users count is reset at the beginning of every month. Check the Billing history on the [Billing](../billing/billing) page to see the active users of previous subscription periods. - -## Identifying users - -Codemagic distinguishes users by the email address that is associated with their Codemagic account (when starting builds manually) or with the commit author (when triggering builds from a webhook). We recommend setting the email address in your git configuration to match the email address used in Codemagic to avoid getting counted twice. You can configure the email address in your terminal as follows: - -```bash -git config --global user.name "John Doe" -git config --global user.email johndoe@example.com -``` - -## User limit - -To avoid unexpected costs, team owners can limit the maximum number of users allowed to run builds. Any number of users within the limit will be allowed to run builds. If the number of active users for the current subscription period is equal to the limit, builds from other users will be blocked. You can see the blocked build attempts in team settings. - -To allow builds from additional users, team owners can increase the user limit by clicking **Manage billing** in team settings or selecting the team on the Billing page and then clicking **Update user limit** in Billing overview. Note that when decreasing the current limit, the new limit will apply starting from the next subscription period. diff --git a/content/rest-api/applications.md b/content/rest-api/applications.md index 3dfaab6ef..62f51db1f 100644 --- a/content/rest-api/applications.md +++ b/content/rest-api/applications.md @@ -90,7 +90,7 @@ Adds a Git repository to the applications list. | **Name** | **Type** | **Description** | | --------------- | -------- | --------------- | | `repositoryUrl` | `string` | **Required.** SSH or HTTPS URL for cloning the repository. | -| `teamId` | `string` | **Optional.** Team ID, if you wish to add an app directly to one of your teams. You must be an owner of the team specified. | +| `teamId` | `string` | **Optional.** Team ID, if you wish to add an app directly to one of your teams. You must be an admin in the team specified. | #### Example @@ -127,7 +127,7 @@ Creates an application from a private repository with an SSH key | `repositoryUrl` | `string` | **Required.** SSH or HTTPS URL for cloning the repository. | | `sshKey` | `JSON` | **Required.** | | `projectType` | `string` | `flutter-app` when adding Flutter application. | -| `teamId` | `string` | **Optional.** Team ID, if you wish to add an app directly to one of your teams. You must be an owner of the team specified. | +| `teamId` | `string` | **Optional.** Team ID, if you wish to add an app directly to one of your teams. You must be an admin of the team specified. | #### `sshKey` parameter diff --git a/content/rest-api/teams.md b/content/rest-api/teams.md index 042d17d94..a0fe4c553 100644 --- a/content/rest-api/teams.md +++ b/content/rest-api/teams.md @@ -5,7 +5,7 @@ description: API for managing team members weight: 5 --- -This document describes the API endpoints for managing teams. To use this API, you must be a **team owner**. +This document describes the API endpoints for managing teams. To use this API, you must be a **team admin**. >Read more about the [Teams](../getting-started/teams/) feature, the available user roles and permissions. @@ -21,9 +21,10 @@ Invite a new team member to your team. | `email` | `string` | **Required.** User email | | `role` | `string` | **Required.** Could be `owner` or `developer` | -
+
+ +>`developer` role corresponds to the **Member** role and `owner` role corresponds to the **Admin** role in Codemagic UI. ->`developer` role corresponds to the "Member" role in Codemagic UI. #### Example diff --git a/content/yaml-code-signing/signing-android.md b/content/yaml-code-signing/signing-android.md index d548d9e2b..3053e8335 100644 --- a/content/yaml-code-signing/signing-android.md +++ b/content/yaml-code-signing/signing-android.md @@ -13,7 +13,7 @@ All Android applications have to be digitally signed before they are made availa {{< youtube wPpGTY6Sis0 >}} ## Managing and uploading files -Team owner permissions are required to upload and edit files under the **Code signing identities** section. However, all team members can view the file info for any of the uploaded files. +Team admin permissions are required to upload and edit files under the **Code signing identities** section. However, all team members can view the file info for any of the uploaded files. ### Generating a keystore diff --git a/content/yaml-code-signing/signing-ios.md b/content/yaml-code-signing/signing-ios.md index e30367d1c..f29db95f1 100644 --- a/content/yaml-code-signing/signing-ios.md +++ b/content/yaml-code-signing/signing-ios.md @@ -14,7 +14,7 @@ All iOS applications have to be digitally signed before they can be installed on ## Managing and uploading files -Team owner permissions are required to upload and edit files under the **Code signing identities** section. However, all team members can view the file info for any of the uploaded files. +Team admin permissions are required to upload and edit files under the **Code signing identities** section. However, all team members can view the file info for any of the uploaded files. ### Creating the App Store Connect API key diff --git a/content/yaml-publishing/build-dashboards.md b/content/yaml-publishing/build-dashboards.md index 54f604683..5e385a538 100644 --- a/content/yaml-publishing/build-dashboards.md +++ b/content/yaml-publishing/build-dashboards.md @@ -18,7 +18,7 @@ The artifact download links in build dashboards are valid for 24 hours. Download ## Enabling build dashboards -To use build dashboards, team owners will have to enable the feature in team settings. +To use build dashboards, team admins will have to enable the feature in team settings. In team settings, expand the **Build dashboards** section and click **Enable sharing**. This will allow any team member to create dashboards and generate public links to share them. @@ -42,4 +42,4 @@ Build dashboards can be disabled anytime by clicking **Disable sharing**. All generated links to build dashboards are listed in the **Build dashboards** section in team settings. -Links can be revoked by deleting them or when a team owner disables sharing by clicking **Disable sharing**. When sharing is re-enabled, the available links become active again. +Links can be revoked by deleting them or when a team admin disables sharing by clicking **Disable sharing**. When sharing is re-enabled, the available links become active again. diff --git a/content/yaml-running-builds/starting-builds-automatically.md b/content/yaml-running-builds/starting-builds-automatically.md index fc9b3de3a..5164d28bd 100644 --- a/content/yaml-running-builds/starting-builds-automatically.md +++ b/content/yaml-running-builds/starting-builds-automatically.md @@ -11,10 +11,10 @@ In order to fully automate your CI/CD pipeline, you can set up automatic build t `triggering:` section in `codemagic.yaml` defines the events for automatic build triggering and watched branches. If no events are defined, you can start builds only manually. -When using the Flutter workflow editor, by clicking **Update Webhook** under the Webhooks tab, Codemagic automatically adds webhooks to the repositories added via GitHub app or from GitHub, GitLab or Bitbucket via the OAuth integration after you have enabled any of the triggers in this section. For repositories added via SSH or HTTP/HTTPS, or if you are configuring your builds using `codemagic.yaml`, you would have to [set up webhooks manually](../building/webhooks). Note that webhook triggers might not be supported for all repository providers. +For repositories added via SSH or HTTP/HTTPS, or if you are configuring your builds using `codemagic.yaml`, you would have to [set up webhooks manually](../building/webhooks). Note that webhook triggers might not be supported for all repository providers. {{}} -**Note:** Webhooks can be clicked to update by the team owner who connected their repository in the Codemagic UI. +**Note:** The team admin who added the repository can update the webhook by clicking the **Update webhook** button in the Codemagic UI. {{}} ## Build triggers