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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Feature: Documentation on "Publish private" #24527

Open
2 tasks done
piatkiewicz opened this issue Apr 26, 2024 · 6 comments
Open
2 tasks done

馃殌 Feature: Documentation on "Publish private" #24527

piatkiewicz opened this issue Apr 26, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Help/Contributions wanted from community members

Comments

@piatkiewicz
Copy link
Contributor

馃敄 Feature description

It would be very useful to have "Publish private" document describing proper way of publishing new or modified plugin. Currently the document is empty

馃帳 Context

Not sure what should be changed in package.json and other steps

鉁岋笍 Possible Implementation

There could be an example in documentation showing adding a simple <p>hello</p> in @backstage/plugin-catalog-import somewhere, what other changes should be made to prepare it for private publish and how to publish it in some private registry GitHub/ADO Artifacts etc.

馃憖 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

@piatkiewicz piatkiewicz added the enhancement New feature or request label Apr 26, 2024
@subash54
Copy link
Contributor

@piatkiewicz I would like to contribute. Can you assign it to me?

@camilaibs camilaibs added documentation Improvements or additions to documentation help wanted Help/Contributions wanted from community members labels Apr 29, 2024
@benjdlambert
Copy link
Member

Hey 馃憢 thanks for raising this issue!

I think there's definitely room to expand this documentation section to maybe Publishing in general, and talking about publishing from your own repository to publish npm, publishing from your own repository to your own private registry and also publishing from the community plugins repository too.

@subash54 do you think that this makes sense?

@subash54
Copy link
Contributor

@benjdlambert Yeah it will be helpful.
We need to add the following Documents right.

  • Docs to Publish a plugin to npm
  • Docs to Publish a plugin to a private registry
  • Docs to Publish from community plugins to npm or private registry

Can you please verify?

@benjdlambert
Copy link
Member

Last one should be Docs to Publish from Community Plugins repo to the @backstage-community scope or something I think

@djannot
Copy link

djannot commented Jun 9, 2024

@subash54 do you already have a draft available ? I'd like to understand how to use the backend plugin I'm developing without submitting it.

@subash54
Copy link
Contributor

subash54 commented Jun 9, 2024

Hey @benjdlambert and @djannot, I've submitted a PR for publishing the plugins to the private repository.

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 enhancement New feature or request help wanted Help/Contributions wanted from community members
Projects
None yet
Development

No branches or pull requests

5 participants