docs: add development docs

[robertsLando]

No description provided.

[robertsLando]

cc @baparham if you could kindly tell me your opinion about the steps I listed in this document 🙏🏼

[baparham]

I think there was one part of the build-all workflow that automatically uploaded the binaries to the latest release or something, but I'd have to dig into the workflow to find out

[robertsLando]

Yeah when the checkbox Create new draft release of the build-all workflow is not checked it will upload releases to the latest one, problem is that this is a fork and there is no releases so I had to create a fake one first and then I have deleted the "fake" release and renamed the untagged one created by the workflow with the correct changelog. All artifacts have been built successfully 🎉

[baparham]

I thought that the workflow itself posts a summary with the SHAs so they are no longer in the (mutable) release, but rather attached to the workflow that is seemingly immutable. I don't know.

[robertsLando]

I'm not sure about this, let me check

[robertsLando]

I see there is a script in package.json named updateExpected but that is never called in the buildall process. I think that should be manually run and by passing the generated sha in the workflow release:

pkg-fetch/lib/generate-expected-shas.ts

Line 10 in 8015eb2

.option('input', { alias: 'i', default: 'shas.txt', type: 'string' })

[robertsLando]

Ok seems that the sha txt of each version in the release are not used anymore, we actually use the sha shipped with the package instead. I updated the docs with the process to create/update them

[baparham]

I think it's worth highlighting that we like to check a patch by building the binaries as well, since sometimes the patches don't build even if they apply cleanly

[robertsLando]

I think it's worth highlighting that we like to check a patch by building the binaries as well, since sometimes the patches don't build even if they apply cleanly

Do you mean this?

pkg-fetch/lib/bin.ts

Lines 54 to 57 in 549db84

	if (test) {
	await verify(local);
	}
	}

I added to readme a mention to it, thanks 🙏🏼