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

chore: fix missing type in building your own project docs #3407

Merged
merged 8 commits into from
Feb 28, 2024

Conversation

caopengau
Copy link
Contributor

@caopengau caopengau commented Feb 27, 2024

Fixes
prMention missing in the MyMicroserviceProjectOptions interface
defaultReleaseBranch shouldn't be there in the example because this example should solely help with the goal of adding new prMention property, not dragging in what the default options the parent class has.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@caopengau caopengau marked this pull request as draft February 27, 2024 23:21
@codecov-commenter
Copy link

codecov-commenter commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.38%. Comparing base (75072c1) to head (772d754).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3407   +/-   ##
=======================================
  Coverage   96.38%   96.38%           
=======================================
  Files         191      191           
  Lines       37362    37362           
  Branches     3486     3486           
=======================================
+ Hits        36011    36013    +2     
+ Misses       1351     1349    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mrgrain mrgrain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree with removing defaultReleaseBranch. Until now the provided code snippets just work. Removing defaultReleaseBranch makes them fail.

The other improvement looks great!

@caopengau
Copy link
Contributor Author

caopengau commented Feb 28, 2024

@mrgrain The failure is caused by defaultReleaseBranch being required. @eladb Maybe we could make it truely optional now?
Pls have a review on this commit in this PR

@eladb
Copy link
Contributor

eladb commented Feb 28, 2024

Hey, I am no longer the maintainer here :-)

@mrgrain
Copy link
Contributor

mrgrain commented Feb 28, 2024

defaultReleaseBranch will be made optional again as part of GA, see #2976

@caopengau
Copy link
Contributor Author

Great! Reverting the changes to defaultReleaseBranch.

@mrgrain mrgrain changed the title chore: fix readme type error and trim unnecessary property in example chore: docs fix readme type error Feb 28, 2024
@mrgrain mrgrain changed the title chore: docs fix readme type error chore: docs fix missing type in building your own project docs Feb 28, 2024
@mrgrain mrgrain changed the title chore: docs fix missing type in building your own project docs chore: fix missing type in building your own project docs Feb 28, 2024
@mergify mergify bot merged commit 00e308c into projen:main Feb 28, 2024
14 checks passed
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

Successfully merging this pull request may close these issues.

4 participants