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

Add lightweight tags variable funcionality, resolves #14 #17

Merged
merged 6 commits into from
Sep 24, 2018

Conversation

domroutley
Copy link
Contributor

@domroutley domroutley commented Sep 18, 2018

This Pull Request adds the ability for users to use a variable in serverless ${git:describeLight}
that will resolve to git describe --always --tags. This is desirable because it will allow the display of lightweight tags (such as those generated when using GitHub releases). resolves #14

Checklist

  • Functionality added
  • Example in README added
  • Test added
  • Tests passed
  • Linting passed

@coveralls
Copy link

coveralls commented Sep 18, 2018

Coverage Status

Coverage increased (+0.05%) to 98.387% when pulling 44a193e on domroutley:develop into 1d5c4ea on jacob-meacham:develop.

Copy link
Owner

@jacob-meacham jacob-meacham left a comment

Choose a reason for hiding this comment

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

Awesome change, would just like a few more docs!

@@ -18,6 +18,10 @@ functions:
name: ${self:provider.stage}-${self:service}-process-event-batch
description: ${git:branch} - ${git:describe} - ${git:sha1}

processEventBatch2:
Copy link
Owner

Choose a reason for hiding this comment

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

Since describeLight isn't a built-in for git, can you add some more documentation to the README as to what it does?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure thing :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Commit #44a193e has added documentation as requested.

Added explanation of `describeLight` and its difference to `describe`
@jacob-meacham
Copy link
Owner

@domroutley thanks so much for the improvement!

@jacob-meacham jacob-meacham merged commit e6982e8 into jacob-meacham:develop Sep 24, 2018
@jacob-meacham
Copy link
Owner

jacob-meacham commented Sep 24, 2018

@domroutley Released as 3.2.0

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.

git describe --always doesn't show the current tag
3 participants