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

feat: publish atlas on npm #35

Merged
merged 1 commit into from
Aug 14, 2023
Merged

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Aug 14, 2023

Hopefully this will work correctly from the first time

Please double check the package.json for details like name: @edx/openedx-atlas and others.

Testing

  • Test with npm publish dry-run
$ npm publish --dry-run
npm notice 
npm notice 📦  @edx/[email protected]
npm notice === Tarball Contents === 
npm notice 34.5kB LICENSE     
npm notice 6.6kB  README.rst  
npm notice 18.7kB atlas       
npm notice 284B   package.json
npm notice === Tarball Details === 
npm notice name:          @edx/openedx-atlas                               
npm notice version:       1.0.0-semantically-released                      
npm notice filename:      edx-openedx-atlas-1.0.0-semantically-released.tgz
npm notice package size:  19.4 kB                                          
npm notice unpacked size: 60.1 kB                                          
npm notice shasum:        362b419c3092cc221d02e9fe05bee98b8dd55ea7         
npm notice integrity:     sha512-bEPZD061tijTC[...]X9AJWwfSs+/BQ==         
npm notice total files:   4                                                
npm notice 
npm WARN This command requires you to be logged in to https://registry.npmjs.org/ (dry-run)
npm notice Publishing to https://registry.npmjs.org/ with tag latest and default access (dry-run)
+ @edx/[email protected]
  • Test with npm publish then download
$ npm i omarithawi-openedx-atlas

added 1 package in 1s
$ node_modules/.bin/atlas --help
Atlas is a CLI tool that has essentially one command: `atlas pull`

Configuration file:

    Atlas defaults to using a configuration file named `atlas.yml` placed
    in the root directory. Configuration file:

    pull:
      repository: <organization-name>/<repository-name>
  • Dry run semantic-release
$ npx [email protected] --verbose --dry-run
[3:28:08 PM] [semantic-release] › ℹ  Running semantic-release version 21.0.7
[3:28:08 PM] [semantic-release] › ✔  Loaded plugin "verifyConditions" from "@semantic-release/npm"
[3:28:08 PM] [semantic-release] › ✔  Loaded plugin "analyzeCommits" from "@semantic-release/commit-analyzer"
[3:28:08 PM] [semantic-release] › ✔  Loaded plugin "prepare" from "@semantic-release/npm"
[3:28:08 PM] [semantic-release] › ✔  Loaded plugin "publish" from "@semantic-release/npm"
[3:28:08 PM] [semantic-release] › ✔  Loaded plugin "addChannel" from "@semantic-release/npm"
[3:28:16 PM] [semantic-release] › ⚠  Run automated release from branch main on repository [email protected]:Zeit-Labs/openedx-atlas.git in dry-run mode
[3:28:18 PM] [semantic-release] › ✔  Allowed to push to the Git repository
[3:28:18 PM] [semantic-release] › ℹ  Start step "verifyConditions" of plugin "@semantic-release/npm"
....
[3:28:18 PM] [semantic-release] › ℹ  The next release version is 0.4.0
[3:28:18 PM] [semantic-release] › ⚠  Skip step "prepare" of plugin "@semantic-release/npm" in dry-run mode
[3:28:18 PM] [semantic-release] › ⚠  Skip v0.4.0 tag creation in dry-run mode
[3:28:18 PM] [semantic-release] › ⚠  Skip step "publish" of plugin "@semantic-release/npm" in dry-run mode
[3:28:18 PM] [semantic-release] › ✔  Published release 0.4.0 on default channel
[3:28:18 PM] [semantic-release] › ℹ  Release note for version 0.4.0

This contribution is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 14, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@brian-smith-tcril
Copy link
Contributor

brian-smith-tcril commented Aug 14, 2023

my only concern here is that publishing to npm before publishing to pip could cause version differences.

do you have a plan to ensure we have the same version across:

  • github releases
  • npm
  • pip
  • --help

@brian-smith-tcril
Copy link
Contributor

after looking into this a bit, it seems if we merge this we should have 0.4.0 published to npm, and then when we add pip it should bump both npm and pip versions to 0.5.0 (assuming we don't merge another feat: PR in between

I'm happy with this plan!

@brian-smith-tcril brian-smith-tcril merged commit 8c11fb5 into openedx:main Aug 14, 2023
8 checks passed
@openedx-webhooks
Copy link

@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@OmarIthawi OmarIthawi mentioned this pull request Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants