Skip to content

Conversation

rouson
Copy link
Contributor

@rouson rouson commented Oct 29, 2021

This PR completes and updates the README.md description of the above fpm flags to match the description given by fpm build --help.

@awvwgk awvwgk added the documentation Improvements or additions to documentation label Oct 30, 2021
Copy link
Member

@milancurcic milancurcic left a comment

Choose a reason for hiding this comment

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

Thank you @rouson, this looks great.

I wonder about the README info being out of sync with the latest release. These env. variables are currently only available from the main branch, but not in 0.4.0. A user downloading the latest release binary could be confused why these env variables from the README don't work.

I don't know if we have had a discussion or workflow for this situation. Some ideas on how to work around this:

  • main is always == latest release and all development features go into a release candiate branch (e.g. rc-0.5.0). or
  • New release on every new feature merge.

@awvwgk @LKedward what do you think?

Copy link
Member

@LKedward LKedward left a comment

Choose a reason for hiding this comment

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

Thanks Damian @rouson - looks good to me 👍


Yes, I think that issue has cropped up before @milancurcic . My preferred solution would be for development on a separate dev branch or release candidate as you suggest.

@awvwgk
Copy link
Member

awvwgk commented Nov 1, 2021

I don't think we need a separate branch for development (yet). I prefer to have the repository default branch represent the latest development state of a project. Currently the main branch is always in a state that it can be released, we can do this continuously without tagging releases as well (see #569).

I think the main issue is that we don't have a dedicated user documentation for the fpm yet (the docs at https://fpm.fortran-lang.org are targeted at developers). Preferably we can setup documentation with tutorials and how-to guides which always provide the last stable and the latest version of the user documentation.

@rouson
Copy link
Contributor Author

rouson commented Nov 1, 2021

One way to mitigate the problem @milancurcic identified is to release more often. In agile sprints, releases happen every 2-3 weeks. If the main branch is always releasable, there's little downside other than the labor involved, which can be lessened by automated any labor-intensive aspects of releasing.

@LKedward
Copy link
Member

LKedward commented Nov 2, 2021

With two reviews I'll now merge this PR. Thanks everyone.

@LKedward LKedward merged commit 02fdf8d into main Nov 2, 2021
@LKedward LKedward deleted the update-readme branch November 2, 2021 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants