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.

Sign up for GitHub

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

docs(handbook): Add information about custom pre-staging environment #2886

Merged
merged 3 commits into from
Jan 7, 2025
Merged

docs(handbook): Add information about custom pre-staging environment #2886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
214816f
Add information about custom pre-staging environment
ppawlowski Dec 18, 2024
60c33f5
Optimised images with calibre/image-actions
github-actions[bot] Dec 18, 2024
b4f763a
Rewrite steps 1 and 2
ppawlowski Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/handbook/development/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,25 @@ The environment itself will then be available at: `https://<pr-number>.flowfuse.

Access credentials for the pre-staging environment are located in the FlowFuse 1Password vault.

The FlowFuse application deployed from the Pull Request comes pre-configured. The environment is terminated upon PR merging or closure.
The FlowFuse application deployed from the Pull Request comes pre-configured. The environment is terminated upon PR merging or closure.

#### Custom Pre-Staging Environment

By default, a pre-staging environment is automatically created for each Pull Request made in the `flowfuse/flowfuse` repository, containing changes from the related feature branch.
However, there are instances where it is necessary to test changes or features made in the dependency packages of `flowfuse/flowfuse`.
This can be accomplished by triggering a GitHub Actions pipeline to create a pre-staging environment with additional input parameters.

To create a customized pre-staging environment, please follow the steps below:
1. Push the changes you want to test to the feature branch of the specific package's repository, ie. `nr-project-nodes`.
2. In the `flowfuse/flowfuse` repository, create a new feature branch. Use this branch to make any necessary changes that depend on the updated package from step 1, if applicable.
3. Create a Pull Request for the changes in the `flowfuse/flowfuse` repository.
4. Navigate to the [Create pre-staging environment workflow page](https://github.com/FlowFuse/flowfuse/actions/workflows/branch-deploy.yaml) in the Actions tab of the `flowfuse/flowfuse` repository.
5. On the right side, click the `Run workflow` button.
6. Complete the `Pull request number` field and the dependent package feature branch name.

![Create pre-staging environment workflow inputs](../images/screenshots/gh-pre-staging-workflow-inputs.png)

7. Click the `Run workflow` button and wait for the results. A Slack notification will be sent to the `gh-pipelines` channel with the link to the pre-staging environment.


[website-repo]: https://github.com/FlowFuse/website
Binary file added src/handbook/images/screenshots/gh-pre-staging-workflow-inputs.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading