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.

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

change master to main #602

Merged
merged 2 commits into from
Aug 3, 2022
Merged

change master to main #602

merged 2 commits into from
Aug 3, 2022

Conversation

jmitrevs
Copy link
Contributor

@jmitrevs jmitrevs commented Jul 13, 2022

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.

  • Other (Specify)

Tests

Test Configuration:

Checklist

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

@thesps
Copy link
Contributor

thesps commented Jul 18, 2022

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
Copy link
Contributor

thesps commented Jul 18, 2022

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

@jmitrevs jmitrevs requested a review from jmduarte August 3, 2022 20:23
Copy link
Member

@jmduarte jmduarte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the changes look good to me. Also, for now we can keep the sphinx workflow running on main in case we "backport" documentation updates that describe prior releases.

@jmduarte jmduarte merged commit 82dfea9 into main Aug 3, 2022
@jmduarte jmduarte deleted the main-name-update branch November 2, 2022 02:37
calad0i pushed a commit to calad0i/hls4ml that referenced this pull request Jul 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants