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

776 docs publish docs for minor version not for every patch #777

Merged

Conversation

davorrunje
Copy link
Collaborator

Description

Publish documentation under minor version instead of patch (e.g. 0.1 instead of 0.1.x).

Fixes # (issue number)

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples, or any documentation updates)

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have added tests to validate the effectiveness of my fix or the functionality of my new feature
  • Both new and existing unit tests pass successfully on my local environment by running scripts/test-cov.sh
  • I have ensured that static analysis tests are passing by running scripts/static-anaylysis.sh
  • I have included code examples to illustrate the modifications

@davorrunje davorrunje linked an issue Sep 29, 2023 that may be closed by this pull request
@@ -22,7 +22,7 @@ jobs:
path: .cache
- run: pip install -e ".[dev]"
- run: ./scripts/build-docs.sh
- run: echo "VERSION=$(python3 -c 'from importlib.metadata import version; print(version("""faststream"""))')" >> $GITHUB_ENV
- run: echo "VERSION=$(python3 -c 'from importlib.metadata import version; print(".".join(version("faststream").split(".")[:2]))')" >> $GITHUB_ENV
Copy link
Contributor

Choose a reason for hiding this comment

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

This will not work. VERSION itself is inside double quotes and then python lines are inside single quotes.
You need to use triple quotes for strings.

Copy link
Contributor

@kumaranvpl kumaranvpl left a comment

Choose a reason for hiding this comment

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

Please use triple quotes for strings in python code

Copy link
Contributor

@kumaranvpl kumaranvpl left a comment

Choose a reason for hiding this comment

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

Let's merge it.

@kumaranvpl kumaranvpl added this pull request to the merge queue Sep 29, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 29, 2023
@kumaranvpl kumaranvpl added this pull request to the merge queue Sep 29, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 29, 2023
@kumaranvpl kumaranvpl added this pull request to the merge queue Sep 29, 2023
Merged via the queue into main with commit ec0bc25 Sep 29, 2023
18 checks passed
@kumaranvpl kumaranvpl deleted the 776-docs-publish-docs-for-minor-version-not-for-every-patch branch September 29, 2023 12:44
@davorrunje davorrunje added the documentation Improvements or additions to documentation label Oct 4, 2023
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.

Docs: publish docs for minor version, not for every patch
2 participants