Add Bitrise ( CI provider ) manager

secustor commented 1 year ago

What would you like Renovate to be able to do?

Bitrise is a platform which provides CI services for mobile apps.

Bitrise uses step definitions which are defined in yaml files with the name bitrise.yaml.

Users of Bitrise are:

reddit
duolingo
equinox
...

If you have any ideas on how this should be implemented, please tell us here.

Steps are hosted and managed by repos with following pattern: https://github.com/bitrise-steplib/steps-{{step reference}}.

format_version: 11
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
project_type: android
app:
  envs:
  - MY_NAME: My Name
workflows:
  test:
    steps:
    - script@1.1.5:
        inputs:
        - content: echo "Hello ${MY_NAME}!"

Should result in a dependency with github-release datasource and bitrise-steplib/steps-script as packageName.

If default_step_lib_source deviates from https://github.com/bitrise-io/bitrise-steplib.git, skipReason should be set as we have no datasource to extract the folders in a generic way.

Is this a feature you are interested in implementing yourself?

Maybe

github-actions[bot] commented 1 year ago

Hi there,

You're asking us to support a new package manager. We need to know some basic information about this package manager first. Please copy/paste the new package manager questionnaire, and fill it out in full.

Once the questionnaire is filled out we'll decide if we want to support this new manager.

Good luck,

The Renovate team

secustor commented 1 year ago

@ubiratansoares As discussed, could you fill out the questionnaire? Thx!

ubiratansoares commented 1 year ago

@secustor On my list! 🔥

ubiratansoares commented 1 year ago

@secustor : Let me know if I missed anything!

Did you read our documentation on adding a package manager?

[x] I've read the adding a package manager documentation.

Basics

Name of package manager

bitrise (https://bitrise.io/integrations)

What language does this support?

Not a programming language per se, it would be an equivalent of Github Actions or Circle Orbs (hence, YAML)

How popular is this package manager?

Every Bitrise user leverages one of more steps provided by Bitrise, hence, Renovate would serve an entire fleet of iOS/Android/RN/Flutter Engineers building on top of this CI/CD provider

Does this language have other (competing?) package managers?

[ ] Yes (give names)
[x] No

Package File Detection

What type of package files and names does it use?

Mainly one YAML file called by bitrise.yml. A working example can be found on this DuckDuckGo fork

What fileMatch pattern(s) should be used?

The most suitable to match exactly bitrise.y(a)ml at root folder

Is it likely that many users would need to extend this pattern for custom file names?

[ ] Yes
[x] No

Is the fileMatch pattern likely to get many "false hits" for files that have nothing to do with package management?

Not sure tbh

Parsing and Extraction

Can package files have "local" links to each other that need to be resolved?

No, there is one single file to handle

Is there a reason why package files need to be parsed together (in serial) instead of independently?

No, there is one single file to handle

What format/syntax is the package file in?

[ ] JSON
[ ] TOML
[x] YAML
[ ] Custom (explain below)

How do you suggest parsing the file?

[x] Off the shelf parser
[x] Using regex
[x] Custom-parsed line by line
[ ] Other

Several options may work here

Does the package file structure distinguish between different "types" of dependencies? e.g. production dependencies, development dependencies, etc?

[ ] Yes, production and development dependencies
[x] No, all dependencies are treated the same

List all the sources/syntaxes of dependencies that can be extracted

N/A

Describe which types of dependencies above are supported and which will be implemented in future

N/A

Versioning

What versioning scheme does the package file(s) use?

SemVer (Major.Minor.Patch)

Does this versioning scheme support range constraints, e.g. `^1.0.0` or `1.x`?

[x] Supports range constraints (e.g ^1.0.0 or 1.x)
[ ] No

Lookup

Is a new datasource required? Provide details

[x] Yes, provide details.
[ ] No.

We may need a new data source since we have two options for getting CI steps and their respective versions. It'll depend on how we want to crawl data about Bitrise Steps.

We have the collection of Bitrise Steps aggregated (automatically) in a mono-repo maintained by Bitrise, from where we can get all step names and all available versions for each step on top of folder/path parsing. If I'm not missing anything, a new Data Source might be required here. The advantage of implementing this option is getting all steps + versions in a single Git clone or single API call to get the latest archive for the main branch
We also have the Github organization where Bitrise hosts all source code for all steps collected in the mono-repo mentioned above. In this case, each repository matches a CI step and a Github Release / Github Tag is available for each step, which means we don't need these two Data Sources, but we eventually have to loop for all repos on that organization
NOTE the naming is not consistent some are prefixed with bitrise-step- other are step-.

Will users need the capability to specify a custom host/registry to look up? Can it be found within the package files, or within other files inside the repository, or would it require Renovate configuration?

No

Do the package files have any "constraints" on the parent language (e.g. supports only v3.x of Python) or platform (Linux, Windows, etc.) that should be used in the lookup procedure?

No

Will users need the ability to configure language or other constraints using Renovate config?

No

Artifacts

Are lock files or checksum files used? Are they mandatory?

No

Other

Is there anything else to know about this package manager?

I don't think so, but happy to go for anything that's missing!

renovate-release commented 1 month ago

:tada: This issue has been resolved in version 38.7.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

renovatebot / renovate