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

Setup thread #1

Closed
3 tasks done
karfau opened this issue Aug 18, 2023 · 16 comments
Closed
3 tasks done

Setup thread #1

karfau opened this issue Aug 18, 2023 · 16 comments

Comments

@karfau
Copy link
Member

karfau commented Aug 18, 2023

  • lisense (suggestion MIT, to be aligned with xmldom)
  • ci (tests, type checks, linting, prettier, ...?)
  • release (just GitHub for now until npm is configurable?)

@cjbarth let's discuss stuff here to make it visible

@cjbarth
Copy link
Collaborator

cjbarth commented Aug 18, 2023

I'm happy with MIT.
I'll probably just use mocha/chai for testing, istanbul/nyc for code coverage, eslint/prettier for code quality, and typescript/ts-node for TypeScript.

I'll probably also add some GitHub workflows for CodeQL and Dependabot along with checks against Node@ n-1, n, and n+1.

I'm happy doing GitHub for now, did you want to use the auto-changelog tool (my fork of GREN) for this along with release-it?

@karfau
Copy link
Member Author

karfau commented Aug 19, 2023

The one thing I would like to avoid is another manual release process. So if it can be automated it would be really valuable.
(I'm currently using auto-changelog in xmldom in a very manual fashion and it will hopefully change to an automated process soon, but there are quite some things to consider and decide.)

@cjbarth
Copy link
Collaborator

cjbarth commented Aug 24, 2023

Using release-it I pretty much have an automated process. There is one more thing I can improve with changelog generation that would make it fully automatic. However, since it only takes literally 1 minute to do a release, I prefer to keep it manual in node-saml and passport-saml, and even xml-crypto; it keeps just one last set of eyes on the process to make sure everything goes right. Otherwise it is a "yes", "yes", "yes" kind of release answering script prompts.

I'll invest in the last little bit for the changelog generation, but I was wondering what automated release process you'd like to use because I'm not aware of any that I 100% trust to do the right thing (correct changelog, correct semver version bump, etc.).

Having said that, I'd like to see if we can make progress on this to alleviate some issue I and others are experiencing: goto100/xpath#126. Once we get the first commit, the rest should go quickly since I've already pretty much written all the code and have the scaffolding from other projects.

@karfau
Copy link
Member Author

karfau commented Aug 25, 2023

Sounds great.

In general I just wanted to make you aware of the situation in xmldom, but it is nothing that should have any impact on this repo.

(More the other way around: looking forward to be inspired.)

@cjbarth
Copy link
Collaborator

cjbarth commented Aug 25, 2023

Did you want to do an npm init and commit that so that everything is aligned with the way you'd like it? Then I'll start making PRs for the rest.

@karfau
Copy link
Member Author

karfau commented Aug 27, 2023

Sorry for the late response.
I hope you didn't wait for me to do that.
Since we are not able to publish to npm right now, I would expect you can run that command and if there is any issue I can file a PR.
My resources are quite low right now, so please go ahead for now.
I'm following the repo, so I will be aware what is happening, but not always able to respond within a day

@cjbarth
Copy link
Collaborator

cjbarth commented Aug 31, 2023

Do we want to use the main or master branch for this?

@karfau
Copy link
Member Author

karfau commented Aug 31, 2023

I would prefer main

@cjbarth
Copy link
Collaborator

cjbarth commented Sep 8, 2023

The first commit is up, and I'll start making PRs for the rest of the work. Did you want to review the PRs I make, or just let me review and land them myself?

@karfau
Copy link
Member Author

karfau commented Sep 8, 2023

I'm quite busy/overloaded right now, go ahead and do what you need to do.
If you want my feedback on something specific you can of course file a PR and ask for my review.

@cjbarth
Copy link
Collaborator

cjbarth commented Sep 15, 2023

How is all the code looking now? Did you want me to try to do a tag and push to NPM? If you do it for the first one, even if there is no CHANGELOG, then we can do a semver-patch release that is an automated release with the CHANGELOG updated. I've updated my CHANGELOG building tools to hopefully do the right thing.

@karfau
Copy link
Member Author

karfau commented Sep 15, 2023

Sadly I still have not heard back from the current npm org owner.
We will have to stick to publishing on github for now until this is resolved. Or temporarily use a different scope to publish it if it is important...

@karfau
Copy link
Member Author

karfau commented Sep 15, 2023

@brodybits is there any chance for you to answer my questions/request any time soon, now that everything else is ready?

@karfau
Copy link
Member Author

karfau commented Sep 16, 2023

@cjbarth I approved your request for gitkraken.

I'm thinking of creating some community channel like slack or discord to be able to offer some more direct communication, without the need to file or comment on an issue.

Are you up for it?
Any suggestion/preference?

@cjbarth
Copy link
Collaborator

cjbarth commented Sep 16, 2023

At node-saml, we use Slack, however, we only use it for maintainers. We really want people with questions to open an issue or Discussion so that the question and its answer become public knowledge. There are several that watch that project and contribute to issues and discussions but nothing else, and they are super helpful. They turn around and often point to other discussions and issues to help noobs get up to speed and answer questions they have which have already been answered.

So, long story short, I'm in favor of Slack, but only for maintainers.

@karfau
Copy link
Member Author

karfau commented Oct 9, 2023

https://www.npmjs.com/package/@xmldom/is-dom-node
Time to celebrate and close this ticket.
Great work.

@karfau karfau closed this as completed Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants