Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Delete references to pending issues before releasing 1.0 from readme #173

Merged
merged 2 commits into from
Dec 20, 2019

Conversation

bdsl
Copy link
Contributor

@bdsl bdsl commented Dec 20, 2019

Yes, technically 0 is a number, but we don't need to mention it.

Yes, technicall 0 is a number, but we don't need to mention it.
@bdsl
Copy link
Contributor Author

bdsl commented Dec 20, 2019

I'm not sure why the checks have failed on this change.

@Kharhamel
Copy link
Collaborator

Kharhamel commented Dec 20, 2019

The ci always tries to regenerate the files and then compare to what is commited. The php doc has been updated recently which cause a change in the doc block of a generated function.

You need to update the doc of you local project before regenerating the files (check CONTRIBUTING.md to see how to do all of this).
I can do it myself if it is not practical for you.

@bdsl
Copy link
Contributor Author

bdsl commented Dec 20, 2019

Ok, I've run the generator and commited the change.

I wonder if there's interest in making this proccess more automated - I might be able to work on that. Potentially you could have a bot to submit PRs when the upstream docs change, or remove the generated stuff from source control entirely and make it just part of a build. Maybe have two github repos, one manually edited without the generated stuff, and one auto generated based on a build from the first one and including the generated code for people to download and use.

@Kharhamel Kharhamel merged commit 0a50e83 into thecodingmachine:master Dec 20, 2019
@Kharhamel
Copy link
Collaborator

I don't know. I like that it is still commited and has to be manually regenerated by a person, this makes it easier to track who modified what. You also need to have a local copy of the generated files to run your tests locally.

@Kharhamel
Copy link
Collaborator

Also, people than require the library via composer don't download the generator code since it is labeled as export-ignore in .gitattributes

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants