Releases: piotrl/github-profile-card
3.1.0 - hideTopLanguages and HTTPS by default on demo page
This release contains 20 commits since March 2019.
-
[feat] #26 Enable HTTPS by default in https://github-profile.com/. Thanks @Giorgi for pointing out 🎉
-
[feat] #25 New option
hideTopLanguages
section, when you think network traffic for calculating top languages is too much for you. Thanks @Giorgi for contribution 🎉 -
[fix] 5 dependency security updates as GitHub suggests ;) However only devDependency as root project does not have any dependencies.
-
[chore] Minor documentation updates
-
[chore] Remove
bower
config. I'm not going to be published there anymore.
3.0.0 - Years of slight maintenance
Okay, so last release was in 2016 - it's quite a long time.
During this time I had few attempts to upgrade maintainability of the project and often failed - but not today!
This release contains 26 commits:
- 12 commits in 2017
- 5 commits in 2018
- 9 commits in 2019 (all within last 4 hours 😅)
Changelog
Project board for 3.0.x releases (previously - 2.1.x)
-
[feat][breaking-change] Now we bundle both CSS and JS in single JavaScript file
-
[feat] Live demo now generates configuration to easy copy-paste
-
[docs] Heavy changes in documentation and website
-
[test] Introduced unit-tests (with help of
jest
library) 🎉 -
[test] Initial specs for
CacheStorage
andDOMOperator
🎉 -
[build] Moved whole configuration from gulp to webpack
-
[build] Switch to
yarn
for development and addyarn.lock
-
[build] Replaced flaky
node-sass
with more stabledart-sass
-
[build] Upgrade TypeScript to awesome
3.3.3333
version -
[refactor] Use ES2015 modules
-
[refactor] Minor changes to improve testability of project (will progress on that in next releases)
2.0.1 - Docs updated & New demo page
This release contains only changes in documentation (in 17 commits - nice 😉)
- Polished README instructions
- We've moved to new domain: http://github-profile.com/
- Small redesign of demo page with live configuration: http://github-profile.com/demo/
NPM docs required also update as it had deprecated links and images:
https://www.npmjs.com/package/github-profile-card
2.0.0 - TypeScript & Improvments
We're back after 5 months! Lots of work was made, including completely rewrite project to TypeScript.
Scope of changes qualifies this release to be marked as major.
Plans
Board for release 2.1.x
Main goal is to create webpage where user can configure widget like on current demo page with only reason, that code will be generated.
Webpage requires building layout, I'm not good at that one so it may take a while :)
Second thing to focus is unit testing. It does assure reliability and is must have.
If you have idea how to improve this library, create new issue.
Changelog
Major changes:
-
TypeScript + ES2015 ❤️
Widget had major rewrite with focus on structure and responsibility of components.
Everything has suitable type (even API responses) and lots of ES2015 features were used.
Why? For fun and profit. -
Caching requests
GitHub limits user to make maximum 60 requests, that may cause problems for users that has lots of repositories or when you often refresh page. With introduced caching, problem is solved.
-
HTML API
It highly simplifies installation process, all configuration options can be now placed in HTML.
Not JS initialization required anymore. -
NPM registry
Now you can choose if you want to download widget bybower
ornpm
. Check out npm page
Improvments:
-
Calculating TOP languages
Modified calculation algorithm, now it considers only 10 repositories based on widget sorting (by stars or by update time). I believe this reflects much better current user preferences.
-
Performance
I've analysed few performance problems. Now widget loads faster and doesn't blink on initialization. -
Error handling
Widget now throws error faster if user won't fill required config parameters.
Breaking changes:
Transition is very easy, the best option is just to repeat installation step.
But for matter of clarity, here is list:
-
Dropped
v
prefix from version number. It's just 2.0.0 instead of v2.0.0 -
Changed configuration options
userName
changed tousername
reposheaderText
changed toheaderText
-
After creating object, you have to call init method like here:
var widget = new GitHubCard({...}); widget.init();
v1.2.0 - Reboot
After last release (2 years ago!), some work was done - yet never released.
Changelog:
- Complete rewrite
- Separated rendering from data loading
- Top languages: All requests are in async mode. Loading time is improved.
- Put more focus on README
Apart of old stuff, I've written down goals that library might accomplish and updated README (inspiration: How to use GitHub like a proper human being)
For planned development, see next milestones.
Hotfix: Make compatibility with demo.
v1.1.1 Hotfix. Restore widget variable in library that is used in demo
v1.1.0: Sorting repositiories, add configuration options
I've added options to configure your widget:
- Specify username
- Choose the way to sort repositories
- - Repositories with more stars on the top
- - Lastest updated repositories on top
- How many repositories should be displayed
I also add interactive demo and start use gulp build system (so you will always can have minified and tested scripts in every release).