Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build_type included in documentation, but being reported as incorrect in fastlane-plugin-emerge 0.10.0 #9

Open
gemmakbarlow opened this issue Apr 16, 2024 · 2 comments

Comments

@gemmakbarlow
Copy link

We have recently upgraded our Fastlane plugins for emerge and are receiving the following error in a Fastfile that previously worked -

Could not find option 'build_type' in the list of available options: api_token, file_path, linkmaps, pr_number, branch, sha, base_sha, build_id, base_build_id, repo_name, gitlab_project_id, tag, order_file_version, config_path, app_id_suffix

fastlane action emerge also indicates that build_type is no longer accepted -

Loading documentation for emerge:

+----------------------------+
|           emerge           |
+----------------------------+
| Fastlane plugin for Emerge |
|                            |
|                            |
| Created by Emerge Tools    |
+----------------------------+

+------------------------------------------------------------------+
|                          emerge Options                          |
+------------------+------------------+------------------+---------+
| Key              | Description      | Env Var(s)       | Default |
+------------------+------------------+------------------+---------+
| api_token        | An API token     | EMERGE_API_TOKE  |         |
|                  | for Emerge       | N                |         |
| file_path        | Path to the      | EMERGE_FILE_PAT  |         |
|                  | zipped           | H                |         |
|                  | xcarchive or     |                  |         |
|                  | app to upload    |                  |         |
| linkmaps         | List of paths    |                  |         |
|                  | to linkmaps      |                  |         |
| pr_number        | The PR number    |                  |         |
|                  | that triggered   |                  |         |
|                  | this upload      |                  |         |
| branch           | The current git  |                  |         |
|                  | branch           |                  |         |
| sha              | The git SHA      |                  |         |
|                  | that triggered   |                  |         |
|                  | this build       |                  |         |
| base_sha         | The git SHA of   |                  |         |
|                  | the base build   |                  |         |
| build_id         | **DEPRECATED!**  |                  |         |
|                  | Replaced by      |                  |         |
|                  | `sha` - A        |                  |         |
|                  | string to        |                  |         |
|                  | identify this    |                  |         |
|                  | build            |                  |         |
| base_build_id    | **DEPRECATED!**  |                  |         |
|                  | Replaced by      |                  |         |
|                  | `base_sha` - Id  |                  |         |
|                  | of the build to  |                  |         |
|                  | compare with     |                  |         |
|                  | this upload      |                  |         |
| repo_name        | Full name of     |                  |         |
|                  | the respository  |                  |         |
|                  | this upload was  |                  |         |
|                  | triggered from.  |                  |         |
|                  | For example:     |                  |         |
|                  | EmergeTools/Eme  |                  |         |
|                  | rge              |                  |         |
| gitlab_project_  | Id of the        |                  |         |
| id               | gitlab project   |                  |         |
|                  | this upload was  |                  |         |
|                  | triggered from   |                  |         |
| tag              | String to label  |                  |         |
|                  | the build.       |                  |         |
|                  | Useful for       |                  |         |
|                  | grouping builds  |                  |         |
|                  | together in our  |                  |         |
|                  | dashboard, like  |                  |         |
|                  | development,     |                  |         |
|                  | default, or      |                  |         |
|                  | pull-request     |                  |         |
| order_file_vers  | Version of the   |                  |         |
| ion              | order file to    |                  |         |
|                  | download         |                  |         |
| config_path      | Path to Emerge   |                  |         |
|                  | config path      |                  |         |
| app_id_suffix    | A suffix to      |                  |         |
|                  | append to the    |                  |         |
|                  | application ID   |                  |         |
|                  | to               |                  |         |
|                  | differentiate    |                  |         |
|                  | between          |                  |         |
|                  | different        |                  |         |
|                  | builds of the    |                  |         |
|                  | same app         |                  |         |
+------------------+------------------+------------------+---------+
* = default value is dependent on the user's system

+-------------------------------------------------------------+
|                     emerge Return Value                     |
+-------------------------------------------------------------+
| If successful, returns the upload id of the generated build |
+-------------------------------------------------------------+

More information can be found on https://docs.fastlane.tools/actions/emerge

Is this an intentional deprecation ? Examples in the README in this repo list it as optional.

@gemmakbarlow gemmakbarlow changed the title build_type included in documentation, but being reported as incorrect in fastlane-plugin-emerge 0.10.0 build_type included in documentation, but being reported as incorrect in fastlane-plugin-emerge 0.10.0 Apr 16, 2024
@trevor-e
Copy link

Hi @gemmakbarlow, thanks for reporting, we updated this field to be named tag. I'll add it back to the params list with the deprecation notice.

@gemmakbarlow
Copy link
Author

Ah got it. OK, sounds great ✅ 🎉 🙏🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants