Skip to content

Fix release after the raw rst directive disabled was disabled in PyPI#1282

Merged
tatiana merged 3 commits into
mainfrom
fix-release
Oct 24, 2024
Merged

Fix release after the raw rst directive disabled was disabled in PyPI#1282
tatiana merged 3 commits into
mainfrom
fix-release

Conversation

@tatiana

@tatiana tatiana commented Oct 24, 2024

Copy link
Copy Markdown
Collaborator

We started facing the following error while trying to publish packages to PyPI:

ERROR    `long_description` has syntax errors in markup and would not be
         rendered on PyPI.
         line 88: Warning: "raw" directive disabled.
Checking dist/astronomer_cosmos-1.7.1a1.tar.gz: FAILED

As seen in https://github.com/astronomer/astronomer-cosmos/actions/runs/11485503895/job/31965756381

I was able to reproduce the Github action error by running:

rm -fr dist && python -m build --wheel && twine check dist/*

This PR aims to solve the issue without side effects on Scarf metrics.

This shows a successful release using 98dbf05:
https://github.com/astronomer/astronomer-cosmos/actions/runs/11494737405/job/31992802917

That resulted in the following package being published:
https://pypi.org/project/astronomer-cosmos/1.7.1a1/

As seen in https://github.com/astronomer/astronomer-cosmos/actions/runs/11485503895/job/31965756381

We started facing the following error while trying to publish packages to PyPI:

```
ERROR    `long_description` has syntax errors in markup and would not be
         rendered on PyPI.
         line 88: Warning: "raw" directive disabled.
Checking dist/astronomer_cosmos-1.7.1a1.tar.gz: FAILED
```

I was able to reproduce the Github action error by running:

```
rm -fr dist && python -m build --wheel && twine check dist/*
```

This PR aims to solve the issue, hopefully without side-effects on Scarf metrics.
@netlify

netlify Bot commented Oct 24, 2024

Copy link
Copy Markdown

Deploy Preview for sunny-pastelito-5ecb04 canceled.

Name Link
🔨 Latest commit dfd7730
🔍 Latest deploy log https://app.netlify.com/sites/sunny-pastelito-5ecb04/deploys/6719fabcf695e80008727a73

@tatiana tatiana changed the title Fix release to PyPI after raw rst directive disabled Fix release after the raw rst directive disabled was disabled in PyPI Oct 24, 2024
Comment thread .github/workflows/deploy.yml Outdated
@tatiana tatiana marked this pull request as ready for review October 24, 2024 07:38
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. area:ci Related to CI, Github Actions, or other continuous integration tools labels Oct 24, 2024

@pankajkoti pankajkoti left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice fix. It's sad how GitHub actions add warnings but essentially push breaking changes & not following semver.

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Oct 24, 2024
@tatiana

tatiana commented Oct 24, 2024

Copy link
Copy Markdown
Collaborator Author

I agree, @pankajkoti . Another observation is that the reStructuredText img directive does not support the referrerpolicy property. Time will tell how much this will affect Scarf metrics.

@tatiana tatiana merged commit fcf5c05 into main Oct 24, 2024
@tatiana tatiana deleted the fix-release branch October 24, 2024 07:46
@tatiana tatiana self-assigned this Oct 24, 2024
@codecov

codecov Bot commented Oct 24, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.73%. Comparing base (772ab55) to head (dfd7730).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1282   +/-   ##
=======================================
  Coverage   95.73%   95.73%           
=======================================
  Files          67       67           
  Lines        3965     3965           
=======================================
  Hits         3796     3796           
  Misses        169      169           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tatiana tatiana added this to the Cosmos 1.7.1 milestone Oct 25, 2024
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in #1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244"
error: pathspec 'Is' did not match any file(s) known to git
error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update CODEOWNERS to track all files by @pankajkoti in #1284
* Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
@tatiana tatiana mentioned this pull request Oct 29, 2024
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in #1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244"
error: pathspec 'Is' did not match any file(s) known to git
error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283
* Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update CODEOWNERS to track all files by @pankajkoti in #1284
* Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282
* Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
tatiana added a commit that referenced this pull request Oct 29, 2024
Bug fixes

* Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python
path by @kesompochy in #1252
* Fix displaying dbt docs as menu item in Astro by @tatiana in #1280
* Fix: Replace login by user for clickhouse profile by @petershenri in
#1255

Enhancements

* Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html
by @johnmcochran in #1250
* Minor refactor on VirtualenvOperators & add test for PR by @tatiana in
#1253

Docs

* Add Welcome Section and "What Is Cosmos" Blurb to Home Page by
@cmarteepants and @yanmastin-astro in #1251
* Update the URL for sample dbt docs hosted in Astronomer S3 bucket by
@pankajkoti in #1283
* Add a dedicated scarf tracking pixel to readme by @cmarteepants in #1256

Others

* Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284
* Fix release after the ``raw`` rst directive disabled was disabled in
PyPI by @tatiana in #1282
* Update issue template ``bug.yml`` - cosmos version update in the
dropdown by @pankajkoti in #1275
* Pre-commit hook updates in #1285, #1274, #1254, #1244
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:ci Related to CI, Github Actions, or other continuous integration tools lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants