steps-cache-push

README

Cache Upload

This step implements Cache Upload for bitrise.io.

How to use this Step

Can be run directly with the bitrise CLI, just git clone this repository, cd into it's folder in your Terminal/Command Line and call bitrise run test.

Check the bitrise.yml file for required inputs which have to be added to your .bitrise.secrets.yml file!

Step by step:

1. Open up your Terminal / Command Line
2. git clone the repository
3. cd into the directory of the step (the one you just git cloned)
4. Create a .bitrise.secrets.yml file in the same directory of bitrise.yml - the .bitrise.secrets.yml is a git ignored file, you can store your secrets in
5. Check the bitrise.yml file for any secret you should set in .bitrise.secrets.yml

• Best practice is to mark these options with something like # define these in your .bitrise.secrets.yml, in the app:envs section.

1. Once you have all the required secret parameters in your .bitrise.secrets.yml you can just run this step with the bitrise CLI: bitrise run test

An example .bitrise.secrets.yml file:

envs:
- A_SECRET_PARAM_ONE: the value for secret one
- A_SECRET_PARAM_TWO: the value for secret two

How to create your own step

1. Create a new git repository for your step (don't fork the step template, create a new repository)
2. Copy the step template files into your repository
3. Fill the step.sh with your functionality
4. Wire out your inputs to step.yml (inputs section)
5. Fill out the other parts of the step.yml too
6. Provide test values for the inputs in the bitrise.yml
7. Run your step with bitrise run test - if it works, you're ready

NOTE:

If you want to use your step in your project's bitrise.yml:

1. git push the step into it's repository
2. reference it in your bitrise.yml with the git::PUBLIC-GIT-CLONE-URL@BRANCH step reference style:

- git::https://github.com/user/my-step.git@branch:
   title: My step
   inputs:
   - my_input_1: "my value 1"
   - my_input_2: "my value 2"

You can find more examples of step reference styles in the bitrise CLI repository.

How to contribute to this Step

1. Fork this repository
2. git clone it
3. Create a branch you'll work on
4. To use/test the step just follow the How to use this Step section
5. Do the changes you want to
6. Run/test the step before sending your contribution

• You can also test the step in your bitrise project, either on your Mac or on bitrise.io
• You just have to replace the step ID in your project's bitrise.yml with either a relative path, or with a git URL format
• (relative) path format: instead of - original-step-id: use - path::./relative/path/of/script/on/your/Mac:
• direct git URL format: instead of - original-step-id: use - git::https://github.com/user/step.git@branch:
• You can find more example of alternative step referencing at: https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml

1. Once you're done just commit your changes & create a Pull Request

Share your own Step

You can share your Step or step version with the bitrise CLI. Just run bitrise share and follow the guide it prints.

Documentation

Overview

Cache archive related models and functions.

Cache descriptor file related models and functions.

Cache path and ignore path related functions.

Ignoring symlink target changes for cache invalidation, as we expect the symlinks to be yarn workspace symlink: https://yarnpkg.com/blog/2018/02/15/nohoist/. The symlinks are included in the cache, just not chhecked if the target they point to is changed. If case it is a link to a directory outside of the cached paths (e.g. yarn workspaces), will not add the linked directory to the cache, and will not invalidate the cache if it changes, as we expect them to be part of the repository. If it links to a directory included in the cache already, then also ignoring it. The directory contents will be added to the cache as regular files, no need to check them twice. Symlinks to files are also ignored.

Cache Push step keeps the project's cache in sync with the project's current state based on the defined files to be cached and ignored.

Files to be cached are described by a path and an optional descriptor file path. Files to be cached can be referred by direct file path while multiple files can be selected by referring the container directory. Optional indicator represents a files, based on which the step synchronizes the given file(s). Syntax: file/path/to/cache, dir/to/cache, file/path/to/cache -> based/on/this/file, dir/to/cache -> based/on/this/file

Ignore items are used to ignore certain file(s) from a directory to be cached or to mark that certain file(s) not relevant in cache synchronization. Syntax: not/relevant/file/or/pattern, !file/or/pattern/to/remove/from/cache