fastmachinelearning / hls4ml

Machine learning on FPGAs using HLS

https://fastmachinelearning.org/hls4ml

Apache License 2.0

1.27k stars 409 forks source link

change master to main #602

Closed jmitrevs closed 2 years ago

jmitrevs commented 2 years ago

Description

This PR is just for any changes that we need to make while renaming master to main.

Type of change

For a new feature or function, please create an issue first to discuss it with us before submitting a pull request.

Note: Please delete options that are not relevant.

[x] Other (Specify)

Tests

Test Configuration:

Checklist

[x] I have read the guidelines for contributing.
[x] I have commented my code, particularly in hard-to-understand areas.
[x] I have made corresponding changes to the documentation.
[x] My changes generate no new warnings.

thesps commented 2 years ago

Referring to the change to the workflow build-sphinx.yml, this could also be an opportunity to switch to run that workflow on tag/release rather than commit to main.

thesps commented 2 years ago

I think recent Jenkins test failures relate to this also, for example this fetch references master (from #600 here):

> git fetch --no-tags --force --progress -- https://github.com/fastmachinelearning/hls4ml.git +refs/pull/600/head:refs/remotes/origin/PR-600 +refs/heads/master:refs/remotes/origin/master # timeout=10

I don't think this is specified in any of our test code, ~~so probably the Jenkins setup itself~~.

Edit: this is fixed with a git rebase origin/main for each branch that branched from master

jmitrevs commented 2 years ago

For the sphinx workflow, I have to admit I am not too familiar, but would it make sense that on main it build main, but on a release branch or tag it build the documentation for that tag? That should probably be the official version we upload.

jmitrevs commented 2 years ago

What do people think about this? The changes are minor, so I would propose merging it. About the proposed sphinx workflow change, I think that can be separate.