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

Automate publishing of coding-blog-plugin #20

Closed
TysonMN opened this issue Sep 1, 2020 · 1 comment · Fixed by #21 · May be fixed by #23
Closed

Automate publishing of coding-blog-plugin #20

TysonMN opened this issue Sep 1, 2020 · 1 comment · Fixed by #21 · May be fixed by #23

Comments

@TysonMN
Copy link
Contributor

TysonMN commented Sep 1, 2020

This is a spin off of CONNECT-platform/codedoc#68 (comment).

I would like to automate the steps used to publish coding-blog-plugin to NPM.

@loreanvictor, can you tell me the specific steps you take and commands you execute to publish coding-blog-plugin to NPM? The steps might include

  1. installing build tools,
  2. restoring dependencies,
  3. building,
  4. testing,
  5. creating the package, and
  6. publishing the package.
@loreanvictor
Copy link
Contributor

@bender2k14 so right now the process is as follows:

There is an internal export of plugin functionality that allows using the plugin code within its documentation (with some considerations, since the plugin and the documentation have two separate sets of dependencies). This is used on the docs to verify and document new functionality.

So for each new functionality (a component, post-processor, etc):

  • It is first coded, the code is tested via the docs. This means testing the feature and documenting it almost happen simultaneously
  • Then I typically do a commit titled "bump version" (example), in which merely the version of the package is increased.
  • Then I run npm publish.

To be honest features of the package haven't had many surface consistency issues or similar things to raise the alarm for automated testing (unlike the CLI, for example). It is mostly seeing if something "looks good" since they mostly don't have much complex functionality (this might not be the case in the future). Still, some automated testing ensuring some basic functionality perhaps wouldn't hurt. Besides that, I guess the main thing that can be automated is publishing when there is a bump version commit, so I am unsure how much could this particular library benefit from automated publishing process (since it is already pretty simplistic).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants