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

Add warning for breaking change in fpm #715

Merged
merged 3 commits into from Jun 25, 2023
Merged

Conversation

Carltoffel
Copy link
Member

Fpm 0.8.2 introduced stdlib as a metapackage.
The previous way to include stdlib in a fpm project produces following error:

<ERROR> *cmd_run* Package error: Could not retrieve version string for metapackage key <stdlib>. Check syntax

@Carltoffel
Copy link
Member Author

Maybe someone should disable all these CI checks if the only thing that has changed is the documentation. I don't know much about CI, just found this. Hope it helps.

@awvwgk awvwgk requested a review from perazz June 2, 2023 10:40
Copy link
Contributor

@perazz perazz left a comment

Choose a reason for hiding this comment

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

Thanks a lot @Carltoffel for catching this - Yes this part of the docs definitely needed your suggested update, I will keep that in mind for when more feats are added (version constraints)

README.md Outdated
@@ -199,6 +199,14 @@ To use `stdlib` within your `fpm` project, add the following lines to your `fpm.
stdlib = { git="https://github.com/fortran-lang/stdlib", branch="stdlib-fpm" }
```

> **Warning**
>
> Fpm 0.8.2 and later implements stdlib as a *metapackage*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please use 0.9.0, it’s the release metapackages went officially into

Copy link
Contributor

Choose a reason for hiding this comment

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

We have user documentation at https://fpm.fortran-lang.org/en/spec/metapackages.html

can I ask you to use that link? I think it’s better than referring to a developer page

Copy link
Member

Choose a reason for hiding this comment

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

Would it be better to have the option in from to use stdlib from a branch as advertised here and have it as metapackage as well. This way we don't break backwards compatibility.

Copy link
Contributor

Choose a reason for hiding this comment

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

- use version 0.9.0 because this is the official release
- use a link to the documentation instead of a GitHub discussion
Copy link
Contributor

@perazz perazz left a comment

Choose a reason for hiding this comment

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

Great @Carltoffel, thank you. lgtm.

@jvdp1
Copy link
Member

jvdp1 commented Jun 24, 2023

@perazz @awvwgk @Carltoffel
Is this still revelant since @fortran-lang/fpm#928 is merged? Can it be merged as is? I think so, but I prefer checking first.

@perazz
Copy link
Contributor

perazz commented Jun 25, 2023

Thank you for asking @jvdp1 - yes I agree that this is OK to be merged.

@jvdp1 jvdp1 merged commit 349f602 into fortran-lang:master Jun 25, 2023
15 checks passed
@Carltoffel Carltoffel deleted the patch-1 branch July 26, 2023 12:50
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.

None yet

4 participants