Add life cycle description #2167
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for conda-forge-previews ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jaimergp
reviewed
May 21, 2024
|
@zklaus any progress here? |
|
@conda-forge/core - this is ready for review. You can start reading at https://deploy-preview-2167--conda-forge-previews.netlify.app/docs/maintainer/understanding_conda_forge/. |
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
ocefpaf
reviewed
Aug 8, 2024
ocefpaf
reviewed
Aug 8, 2024
| Package building can be triggered by several events, which are described in the next section. | ||
| In all of those cases, the following sequence plays out. | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
Adding the diagram here just for the sake of visibility. Nice one BTW!
sequenceDiagram
box github
participant f as feedstock
end
box CI provider
participant c as CI
end
box distribution infrastructure
participant s as cf-staging channel
participant cf as conda-forge channel
participant cdn as CDN
end
f->>+c: trigger build
Note right of c: 1. build<br/>2. validate
opt if valid and required (4.)
c->>s: upload packages
s->>c: report reception success/failure
Note right of s: 3. validate
s->>cf: upload packages
cf->>cdn: upload packages
end
c->>-f: report success/failure
ocefpaf
reviewed
Aug 8, 2024
ocefpaf
reviewed
Aug 8, 2024
|
|
||
| First, the version information is updated from upstream sources and stored in the [`cf-graph-countyfair` repo](/docs/maintainer/infrastructure/#regrocf-graph-countyfair), more specifically in the `versions` directory tree, nested by hash with one file per package. | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
sequenceDiagram
participant cfs as cf-scripts
participant gha as github actions
participant cft as conda_forge_tick
participant ups as upstream
participant cfg as cf-graph-countyfair
loop every hour at :15, :45
cfs->>gha: bot-versions
gha->>cft: update-upstream-versions
cft->>cfg: load package information from `graph.json`
loop for every package
cft->>ups: query version
ups->>cft: return version
cft->>cfg: write new version
end
end
ocefpaf
reviewed
Aug 8, 2024
| Second, the main bot CI job, the `bot-bot` action in [`cf-scripts`](/docs/maintainer/infrastructure/#regrocf-scripts) creates PRs for all packages that have a new version available upstream. | ||
| Here is a simplified diagram of how that is done. For the full picture, read [below](#rebuilds-for-migrators). | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
sequenceDiagram
participant cfs as cf-scripts
participant gha as github actions
participant cft as conda_forge_tick
participant fs as feedstock
participant cfg as cf-graph-countyfair
loop self renewing
cfs->>gha: bot-bot
gha->>cft: auto-tick
note right of cfg: the graph now contains<br/>the new version information
cft->>cfg: load package information from `graph.json`
loop for every package
opt if new version
cft->>fs: rewrite recipe and open pr
end
end
gha->>gha: re-trigger bot-bot
end
ocefpaf
reviewed
Aug 8, 2024
|
|
||
| A more complete picture of what `auto-tick` does is the following: | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
sequenceDiagram
participant cfs as cf-scripts
participant gha as github actions
participant cft as conda_forge_tick
participant fs as feedstock
participant cfg as cf-graph-countyfair
loop self renewing
cfs->>gha: bot-bot
gha->>cft: auto-tick
note right of cfg: the graph now contains<br/>the new version information
cft->>cfg: load package information from `graph.json`
loop for every migrator
create participant mg as migrator
cft->>mg: run migrator on graph
note right of mg: 1. filter applicable package to produce effective graph<br/>2. determine migration order<br/>3. run migrator on every possible node
destroy mg
mg->>fs: create migration PR
end
gha->>cfs: deploy, i.e. commit changed pr information
gha->>gha: re-trigger bot-bot
end
ocefpaf
approved these changes
Aug 8, 2024
zklaus
commented
Aug 8, 2024
….io into add-life-cycle
Co-authored-by: Klaus Zimmermann <[email protected]>
….io into add-life-cycle
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
|
I think all comments were addressed. |
|
Let's merge! Further refinements, if needed, can happen in additional PRs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist:
docs/orcommunity/, you have added it to the sidebar in the corresponding_sidebar.jsonfileThis doesn't directly close any issues, but potentially relevant issues and PRs are:
🔍 Preview at https://deploy-preview-2167--conda-forge-previews.netlify.app/docs/maintainer/understanding_conda_forge/